Skip to main content

RegisterWebhookInput

Input to provide information to register a webhook for a given URL.

input RegisterWebhookInput {
  events: [WebhookEvent!]!
  url: URL!
  verificationSecret: String
}

Fields​

RegisterWebhookInput.events ● [WebhookEvent!]! non-null enum​

The events to be monitored. When they occur, the URL will receive a POST request with a payload identifying the affected offer. A URL can be registered for multiple events.

RegisterWebhookInput.url ● URL! non-null scalar​

The URL which will be called when a registered event occurs.

RegisterWebhookInput.verificationSecret ● String scalar​

An optional secret used to sign webhook deliveries with HMAC-SHA256. When set, each POST includes an x-hmac header you can verify on receipt.

Member Of​

registerWebhook mutation