WebhookSubscription

A Subscription to the webhooks service. It describes the registration of a callback url (the endpoint) and a list of event types the client wants to be notified of.

type WebhookSubscription {
  id: ID!
  label: String!
  endpoint: String!
  secret: String
  eventTypes: [String!]!
  createdAt: DateTime!
  updatedAt: DateTime!
  statusInfo: WebhookSubscriptionStatusInfo!
  kpi: WebhookSubscriptionKpi
  webhookEventLogs(
    first: Int! = 50
    after: String
    filters: NestedWebhookEventLogFiltersInput
  ): WebhookEventLogsConnection
}

Fields

WebhookSubscription.id ● ID! non-null scalar

Unique identifier of the Subscription

WebhookSubscription.label ● String! non-null scalar

A client provided short description of the Subscription

WebhookSubscription.endpoint ● String! non-null scalar

The callback URL to be used for POSTing events

WebhookSubscription.secret ● String scalar

The optional secret to secure incoming webhook calls. We recommend a UUID-4 to be future proof. (max 36 characters)

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

The types of subscribed events A simple list of event names as strings

WebhookSubscription.createdAt ● DateTime! non-null scalar

Date the Subscription has been created

WebhookSubscription.updatedAt ● DateTime! non-null scalar

Last date the Subscription has been updated, except for state changes

WebhookSubscription.statusInfo ● WebhookSubscriptionStatusInfo! non-null interface

The current state of the Subscription

WebhookSubscription.kpi ● WebhookSubscriptionKpi object

KPI data about the subscription (7 last days)

WebhookSubscription.webhookEventLogs ● WebhookEventLogsConnection object

Array of webhook event logs related to the subscription

WebhookSubscription.webhookEventLogs.first ● Int! non-null scalar

WebhookSubscription.webhookEventLogs.after ● String scalar

WebhookSubscription.webhookEventLogs.filters ● NestedWebhookEventLogFiltersInput input

Returned By

webhookSubscription query

Member Of

WebhookEventLog object ● WebhookSubscriptionsEdge object ● WebhookSubscriptionSuccessPayload object