Middesk APIWebhooks

Create a webhook event schema

Creates a custom GraphQL schema for one webhook event namespace. For supported business events, the schema is a root-level Business selection set such as ”{ id name runs { id agent } }”.

Authentication

AuthorizationBearer

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

Path parameters

webhook_idstringRequired
Webhook ID

Request

This endpoint expects an object.
namespacestringRequired
Event namespace for the schema override. Currently supported business event namespaces are business.created and business.updated.
schemastringRequired

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 } }”. Use snake_case field names; do not wrap the query in “object { … }”.

Response

webhook event schema created
objectenum
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, 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_atdatetime
updated_atdatetime

Errors

422
Create Webhook Event Schema Request Unprocessable Entity Error