sendAppWebhookTestEvent

Requires permission settings:apps:install.

Queues a test event to an installed app's own webhook endpoint and returns the delivery so its outcome can be followed. The test is signed with the app's secret and is not held by the app's pause. Requires permission to install apps.

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 SendAppWebhookTestEvent($installationId: ID!) {
  sendAppWebhookTestEvent(installationId: $installationId) {
    id
    status
    createdAt
    appInstallationId
    attempts
    deliveredAt
  }
}

cURL

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

Variables:

{
  "installationId": "id"
}

Response:

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

sendAppWebhookTestEvent(
  installationId: ID!
): WebhookDelivery!

Arguments

sendAppWebhookTestEvent.installationId ● ID! non-null scalar

The ID of the app installation.

Type

WebhookDelivery object

One attempt to deliver an event to a webhook.