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).
| Argument | Type | Description |
|---|---|---|
endpointId | ID! | Required. |
first | Int |
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!): WebhookEndpointWithSecretResultRegister a webhook endpoint. Returns the signing secret exactly once.
| Argument | Type | Description |
|---|---|---|
input | CreateWebhookEndpointInput! | Required. |
deleteWebhookEndpoint
deleteWebhookEndpoint(id: ID!): DeleteWebhookEndpointResultDelete a webhook endpoint (pending deliveries are dropped).
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
pingWebhookEndpoint
pingWebhookEndpoint(id: ID!): PingWebhookResultQueue a signed webhook.ping delivery to test an endpoint end to end.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
rotateWebhookSecret
rotateWebhookSecret(id: ID!): WebhookEndpointWithSecretResultRotate an endpoint's signing secret. The new secret is returned exactly once; the old one stops working immediately.
| Argument | Type | Description |
|---|---|---|
id | ID! | Required. |
updateWebhookEndpoint
updateWebhookEndpoint(input: UpdateWebhookEndpointInput!): WebhookEndpointResultUpdate a webhook endpoint's URL, description, event filter, or active flag.
| Argument | Type | Description |
|---|---|---|
input | UpdateWebhookEndpointInput! | Required. |