create_webhook_subscription

Create a web hook subscription for an organization.

Input fields

authentication (WebhookAuthenticationConfigurationInput)

Optional configuration settings to authenticate with oauth when sending a request to the callback_url.

callback_url (Url!)

The URL that should receive events via HTTP POST from this subscription.

event_types ([WebhookEventType!]!)

The list of event types you are interested in.

organization_sentera_id (ID!)

The organization that should have the webhook subscription.

Return fields

callback_url (Url!)

The URL to which the system should send events via HTTP POST.

event_types ([WebhookEventType!]!)

A list of the event types the system should send to the registered HTTP endpoint.

events (WebhookEventsQueryResult!)

A list of events for this webhook subscription.

Argument Type Description
date_range DateRange

Optional parameter to filter results to events created within a specific date range.

event_type WebhookEventType

Optional parameter to filter results to a specific type of event.

pagination Pagination!

Required pagination information.

status WebhookEventStatus

Optional parameter to filter results to events in a specific status.

sentera_id (ID!)

A system-generated key identifying a specific instance of a webhook subscription.

Examples

Create a webhook subscription.

Creates a webhook subscription for an organization. Events do not bubble up the organization tree so you'll need to create a subscription for each organization for which you want to receive webhooks.

Try this example in GraphiQL
mutation CreateWebhookSubscription {
  create_webhook_subscription(organization_sentera_id: "6aeagny_OR_w3njAcmeGrand_CV_deve_ef64a0fce_220112_111024", callback_url: "https://example.com/webhooks", event_types: [FEATURE_SET_CREATED]) {
  sentera_id
  event_types
  callback_url
  }
}

{
  "data": {
  "create_webhook_subscription": {
    "sentera_id": "b6i0chc_WS_w3njAcmeGrand_CV_deve_85c3a6365_220131_132709",
    "event_types": [
      "FEATURE_SET_CREATED"
    ],
    "callback_url": "https://example.com/webhooks"
  }
  }
}