Skip to main content

webhookDryRun Mutation

Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the query). Requires permission relevant to processed event.

Requires the AUTHENTICATED_STAFF_USERpermission.
webhookDryRun(
  objectId: ID!
  query: String!
): WebhookDryRun
Details
type WebhookDryRun {
  payload: JSONString
  errors: [WebhookDryRunError!]!
}

Arguments​

objectId ● ID!​

The ID of an object to serialize.

query ● String!​

The subscription query that defines the webhook event and its payload.

Type​

WebhookDryRun​

Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the query). Requires permission relevant to processed event.

Requires the AUTHENTICATED_STAFF_USERpermission.