Skip to main content

WebhookSubscription

A webhook subscription for outbound event delivery.

See Webhooks guide for integration details.

type WebhookSubscription {
  id: ID!
  secret: String
  url: String!
  label: String!
  eventTypes: [String!]!
  headers: [WebhookHeader!]
  version: String!
  createdAt: DateTime
  updatedAt: DateTime
  deleted: Boolean
  deliveryPaused: Boolean
}

Fields​

WebhookSubscription.id ● ID! non-null scalar​

WebhookSubscription.secret ● String scalar​

The secret used to verify webhook payloads.

WebhookSubscription.url ● String! non-null scalar​

WebhookSubscription.label ● String! non-null scalar​

WebhookSubscription.eventTypes ● [String!]! non-null scalar​

Subscribed event types (lowercase dotted strings). See CreateWebhookInput for the full list of valid values.

WebhookSubscription.headers ● [WebhookHeader!] list object​

WebhookSubscription.version ● String! non-null scalar​

WebhookSubscription.createdAt ● DateTime scalar​

WebhookSubscription.updatedAt ● DateTime scalar​

WebhookSubscription.deleted ● Boolean scalar​

WebhookSubscription.deliveryPaused ● Boolean scalar​

Returned By​

webhook query ● webhooks query

Member Of​

CreateWebhookPayload object ● UpdateWebhookPayload object