Skip to main content

CreateWebhookSubscriptionInput

Defines the input for creating a new webhook subscription.

input CreateWebhookSubscriptionInput {
  description: String!
  filters: [WebhookSubscriptionFilterInput!]
  url: URL!
  webhookEventTypeNames: [String!]!
}

Fields​

CreateWebhookSubscriptionInput.description ● String! non-null scalar​

A descriptive name for the subscription.

CreateWebhookSubscriptionInput.filters ● [WebhookSubscriptionFilterInput!] list input​

Filters for webhook messages received by this subscription. Optional.

By specifying a filter, a webhook subscription can be used to only receive messages for a given Event, Contact Store, Continuing Education Contact Store or Membership Contact Store in EventsAir.

A limit of 10 filters can be defined for a subscription, otherwise a BAD_USER_INPUT error will be thrown.

CreateWebhookSubscriptionInput.url ● URL! non-null scalar​

The URL of the webhook subscription.

CreateWebhookSubscriptionInput.webhookEventTypeNames ● [String!]! non-null scalar​

A list of webhook event type names to filter on.

Member Of​

createWebhookSubscription mutation