c.l.cladDocs

Webhooks

Every webhook endpoint and delivery query and mutation.

Subscribe to events, verify signed deliveries, and manage endpoints.

Queries

webhookDeliveries

webhookDeliveries(endpointId: ID!, first: Int): [WebhookDelivery!]

Recent deliveries for an endpoint, newest first (max 100).

ArgumentTypeDescription
endpointIdID!Required.
firstInt

webhookEndpoints

webhookEndpoints: [WebhookEndpoint!]

All webhook endpoints registered for the organization.

webhookEventTypes

webhookEventTypes: [String!]

Every event type webhooks can subscribe to.

Mutations

createWebhookEndpoint

createWebhookEndpoint(input: CreateWebhookEndpointInput!): WebhookEndpointWithSecretResult

Register a webhook endpoint. Returns the signing secret exactly once.

ArgumentTypeDescription
inputCreateWebhookEndpointInput!Required.

deleteWebhookEndpoint

deleteWebhookEndpoint(id: ID!): DeleteWebhookEndpointResult

Delete a webhook endpoint (pending deliveries are dropped).

ArgumentTypeDescription
idID!Required.

pingWebhookEndpoint

pingWebhookEndpoint(id: ID!): PingWebhookResult

Queue a signed webhook.ping delivery to test an endpoint end to end.

ArgumentTypeDescription
idID!Required.

rotateWebhookSecret

rotateWebhookSecret(id: ID!): WebhookEndpointWithSecretResult

Rotate an endpoint's signing secret. The new secret is returned exactly once; the old one stops working immediately.

ArgumentTypeDescription
idID!Required.

updateWebhookEndpoint

updateWebhookEndpoint(input: UpdateWebhookEndpointInput!): WebhookEndpointResult

Update a webhook endpoint's URL, description, event filter, or active flag.

ArgumentTypeDescription
inputUpdateWebhookEndpointInput!Required.