v3

latestOpenAPI 3.1.02026-07-3178343213.9 KB

webhooks

Retrieve a webhook event schema

Retrieves one active webhook event schema scoped to the parent webhook.

get/v1/webhooks/{webhook_id}/event_schemas/{id}

Path parameters

webhook_idstring required

Webhook ID

idstring required

Webhook event schema ID

Headers

Authorizationstring required

Bearer authentication

Response

webhook event schema found

object'webhook_event_schema' required

idstring uuid required

Unique identifier for this webhook event schema.

namespacestring required

Event namespace for the schema override. Currently supported business event namespaces are business.created and business.updated.

schemastring required

GraphQL selection set rooted at the event object for the namespace. For business.updated, write fields directly against the Business object, for example "{ id name runs { id agent } }". The selected object replaces only data.object in delivered webhook payloads.

created_atstring date-time required

updated_atstring date-time required