Sign in

v3

latestOpenAPI 3.1.02026-07-3178343213.9 KB
webhooks

Update a webhook event schema

Updates the GraphQL selection set for a webhook event schema. The namespace is immutable. Changes apply to future event snapshots only.

patch/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

Request body

schemastring required

GraphQL selection set rooted at the event object for the namespace. Updating this value affects future event snapshots only. Existing event snapshots continue to deliver the payload captured when the event was created.

Response

webhook event schema updated

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