MImiddesk
webhooks

Update a webhook event schema

Changed on

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.

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

Request

Path parameters

webhook_idstring required

Webhook ID

idstring required

Webhook event schema ID

Request body

schemastring required

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

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, select fields directly from the Business object. The selection replaces only data.object in delivered webhook payloads.

created_atstring date-time required
updated_atstring date-time required

Changes

  • 4c9cd4e834baRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

  • 668373c892ceRevision changes
    • info

      api operation id updateWebhookEventSchema removed and replaced with webhooks_updateWebhookEventSchema