Webhooks API

Query

Root query field

Returns a list of events available for webhooks

Get a webhook by ID

Get a list of all webhooks matching a filter.

Mutation

Root mutation field

Creates and activates a new webhook

Update the configuration of an existing webhook

Deactivates and removes a webhook

Objects

Event

Stringified JSON event payload

HttpHeader

HTTP Header

PageInfo

Pagination information

An end cursor for use in pagination.

Indicates if there are more pages to fetch.

Indicates if there are any pages prior to the current page.

An start cursor for use in pagination.

RegisterableWebhookDescription

Namespace of the event

The name of the event

A short name and/or description mostly for UI convenience

Webhook

Events to subscribe to

Event URNs to filter for

URL of HTTPS endpoint where webhook events are delivered to

Whether the webhook is enabled and receiving deliveries

Get the history of all events delivered to the Webhook's URL

A shared secret used to sign the request payload

A short name and/or description mostly for UI convenience

WebhookDeliveriesConnection

A Webhooks connection

A list of node edges

A list of nodes

Information for pagination

The total count of items in the connection.

WebhookDelivery

WebhookDeliveryEdge

A WebhookDelivery edge

A cursor for use in pagination.

The item at the end of edge.

WebhookDeliveryResult

The HTTP Response from a Webhook Delivery attempt

WebhookEdge

A Webhook edge

A cursor for use in pagination.

The item at the end of edge.

WebhookMutationResult

WebhooksConnection

A Webhooks connection

A list of node edges

A list of nodes

Information for pagination

The total count of items in the connection.

Inputs

RegisterWebhookInput

URL of HTTPS endpoint the webhook should deliver events to

UpdateWebhookInput

URL of HTTPS endpoint the webhook should deliver events to

WebhooksFilter

Enums

WebhookDeliveryStatus

Scalars

Boolean

The Boolean scalar type represents true or false.

DateTime

Datetime scalar type

EventName

A string which contains only lowercase letters, dots and hyphens. For example: "community-article.published"

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Json

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Url

An https URL. For example: "https://example.allthings.me/webhook"

Urn

A string which defines a urn. For example: "urn:allthings:app:82662ee4-0080-4960-8b8f-d7693e6ff3e4:*"

Interfaces

MutationResult

Node

An object with an ID to support global identification.

The object's id

Datetime when the object was created