Webhook

A registered webhook endpoint that receives POST notifications when platform events occur.

type Webhook {
  createdAt: DateTime!
  events: [WebhookEvent!]!
  id: ID!
  url: String!
}

Fields

Webhook.createdAt ● DateTime! non-null scalar

The date-time at which the hook was registered.

Webhook.events ● [WebhookEvent!]! non-null enum

The events which are linked to this webhook and will trigger the URL when they occur.

Webhook.id ● ID! non-null scalar

The ID of the webhook.

Webhook.url ● String! non-null scalar

The URL to which will be called when an event occurs.

Returned By

registerWebhook mutation ● webhooks query

Implemented By

UnregisterWebhookResult union