Middesk APIWebhooks

Retrieve a webhook event schema

Retrieves one active webhook event schema scoped to the parent webhook.

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

Response

webhook event schema found
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

404
Get Webhook Event Schema Request Not Found Error