webhookEndpoints

Requires permission settings:webhooks:read.

Lists the webhook endpoints of your organization. The signing secret is never returned here. Requires permission to read 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

query WebhookEndpoints {
  webhookEndpoints {
    id
    name
    createdAt
    eventTypes
    isActive
    secretHint
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query WebhookEndpoints {\n  webhookEndpoints {\n    id\n    name\n    createdAt\n    eventTypes\n    isActive\n    secretHint\n  }\n}"
}
EOF

Response:

{
  "data": {
    "webhookEndpoints": [
      {
        "id": "id",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "eventTypes": [
          "string"
        ],
        "isActive": true,
        "secretHint": "string"
      }
    ]
  }
}

webhookEndpoints: [WebhookEndpoint!]!

Type

WebhookEndpoint object

A webhook endpoint of the organization. The signing secret is never a field here.