Skip to main content

webhookTrigger Mutation

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 the AUTHENTICATED_STAFF_USERpermission.
webhookTrigger(
objectId: ID!
webhookId: ID!
): WebhookTrigger
Show return type

Arguments

objectId ● ID!

The ID of an object to serialize.

webhookId ● ID!

The ID of the webhook.

Type

WebhookTrigger

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 the AUTHENTICATED_STAFF_USERpermission.