sendWebhookTestEvent

Requires permission settings:webhooks:update.

Queues a test event to a webhook endpoint, even if the endpoint is inactive, and returns the delivery so its outcome can be followed. Requires permission to update webhooks.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SendWebhookTestEvent($endpointId: ID!) {
  sendWebhookTestEvent(endpointId: $endpointId) {
    id
    status
    createdAt
    attempts
    deliveredAt
    endpointId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SendWebhookTestEvent($endpointId: ID!) {\n  sendWebhookTestEvent(endpointId: $endpointId) {\n    id\n    status\n    createdAt\n    attempts\n    deliveredAt\n    endpointId\n  }\n}",
  "variables": {
    "endpointId": "id"
  }
}
EOF

Variables:

{
  "endpointId": "id"
}

Response:

{
  "data": {
    "sendWebhookTestEvent": {
      "id": "id",
      "status": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "attempts": 0,
      "deliveredAt": "2025-01-15T00:00:00Z",
      "endpointId": "string"
    }
  }
}

sendWebhookTestEvent(
  endpointId: ID!
): WebhookDelivery!

Arguments

sendWebhookTestEvent.endpointId ● ID! non-null scalar

The ID of the webhook endpoint.

Type

WebhookDelivery object

One attempt to deliver an event to a webhook.