MImiddesk
webhooks

Create a webhook event schema

Changed on

Creates a custom GraphQL schema for one webhook event namespace. For supported business events, the schema is a root-level Business selection set. See Customize webhook payloads for general guidance. For agent-specific event behavior, see Agent webhook events.

post/v1/webhooks/{webhook_id}/event_schemas

Request

Path parameters

webhook_idstring required

Webhook ID

Request body

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. Use snake_case field names and omit an object wrapper.

Response

webhook event schema created

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 createWebhookEventSchema removed and replaced with webhooks_createWebhookEventSchema