WebhookSubscription

A webhook subscription used to receive messages from EventsAir in response to activities in the platform.

See the webhooks guide for more information.

type WebhookSubscription {
  createdAt: DateTime!
  createdBy: String
  description: String!
  filters: [WebhookSubscriptionFilter!]!
  id: ID!
  isDisabled: Boolean!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  url: URL!
  webhookEventTypeNames: [String!]!
}

Fields

WebhookSubscription.createdAt ● DateTime! non-null scalar

The date and time the record was created.

WebhookSubscription.createdBy ● String scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

WebhookSubscription.description ● String! non-null scalar

A description for the subscription.

WebhookSubscription.filters ● [WebhookSubscriptionFilter!]! non-null object

Filters for webhook messages received by this subscription.

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

WebhookSubscription.id ● ID! non-null scalar

Unique identifier of the webhook subscription.

WebhookSubscription.isDisabled ● Boolean! non-null scalar

A flag indicating whether the webhook subscription is currently disabled.

A webhook subscription will be disabled automatically if all attempts to a specific endpoint fail for a period of 5 days.

WebhookSubscription.lastModifiedAt ● DateTime! non-null scalar

The date and time the record was last modified.

WebhookSubscription.lastModifiedBy ● String scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

WebhookSubscription.url ● URL! non-null scalar

The URL of the webhook subscription.

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

The names of the webhook event types sent to this subscription.

Returned By

webhookSubscription query

Member Of

CreateWebhookSubscriptionPayload object ● DisableWebhookSubscriptionPayload object ● EnableWebhookSubscriptionPayload object ● UpdateWebhookSubscriptionPayload object ● WebhookSubscriptionEdge object