Skip to main content

Webhook

A subscription that sends events for a topic to a URL. Each event is sent as a JSON POST request, signed in the X-Submarine-Webhook-Signature header.

type Webhook {
  channel: Channel!
  createdAt: ISO8601DateTime!
  id: GlobalID!
  status: WebhookStatus!
  topic: WebhookTopic!
  updatedAt: ISO8601DateTime!
  url: Url!
}

Fields​

Webhook.channel ● Channel! non-null object types​

The channel the webhook belongs to.

Webhook.createdAt ● ISO8601DateTime! non-null scalar types​

The date and time when the webhook was created.

Webhook.id ● GlobalID! non-null scalar types​

The webhook's ID.

Webhook.status ● WebhookStatus! non-null enum types​

The webhook's status.

Webhook.topic ● WebhookTopic! non-null enum types​

The topic the webhook subscribes to.

Webhook.updatedAt ● ISO8601DateTime! non-null scalar types​

The date and time when the webhook was last updated.

Webhook.url ● Url! non-null scalar types​

The URL the webhook sends events to.

Returned By​

webhook query

Member Of​

WebhookConnection object ● WebhookCreatePayload object ● WebhookEdge object ● WebhookUpdatePayload object