Skip to main content

WebhookTrigger Object

Trigger a webhook event. Supports a single event (the first, if multiple provided in the webhook.subscription_query). Requires permission relevant to processed event. Successfully delivered webhook returns delivery with status='PENDING' and empty payload.

Requires AUTHENTICATED_STAFF_USERpermission.
type WebhookTrigger {
delivery: EventDelivery
errors: [WebhookTriggerError!]!
}

Fields

WebhookTrigger.delivery ● EventDelivery object miscellaneous

WebhookTrigger.errors ● [WebhookTriggerError!]! non-null object webhooks

Returned By

webhookTrigger mutation