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. See Customize webhook payloads for general guidance. For agent-specific event behavior, see Agent webhook events.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

webhook_idstringRequired

Webhook ID

idstringRequired

Webhook event schema ID

Request

This endpoint expects an object.

schemastringRequired

GraphQL selection set rooted at the event object for the namespace. Updates affect future event snapshots only; existing snapshots retain the payload captured when the event was created.

Response

webhook event schema updated

objectenum

Allowed values:

idstringformat: "uuid"

Unique identifier for this webhook event schema.

namespacestring

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

schemastring

GraphQL selection set rooted at the event object for the namespace. For business.updated, select fields directly from the Business object. The selection replaces only data.object in delivered webhook payloads.

created_atdatetime

updated_atdatetime

Errors

404

Update Webhook Event Schema Request Not Found Error

422

Update Webhook Event Schema Request Unprocessable Entity Error