Skip to main content

Webhook

Webhook settings for publishing change events.

type Webhook {
  additionalHeaders: [KeyValuePair!]
  compressionType: CompressionType
  created: Date!
  deleted: Date!
  email: String
  enabled: Boolean!
  endpoint: String!
  id: ID!
  maxBatchDelayMs: Int!
  maxBatchSize: Int!
  name: String!
  signatureSecret: String
  updated: Date!
  webhookType: WebhookType!
}

Fields​

Webhook.additionalHeaders ● [KeyValuePair!] list scalar​

Collection of custom headers to be added to all http posts to the registered endpoint to support auth

Webhook.compressionType ● CompressionType enum​

Compression Type. If set, request will be compressed in requested format.

Webhook.created ● Date! non-null scalar​

Created DateTime

Webhook.deleted ● Date! non-null scalar​

Deleted DateTime

Webhook.email ● String scalar​

Email address to receive notifications of webhook errors or feature changes

Webhook.enabled ● Boolean! non-null scalar​

May be manually disabled or automatically disabled following long period of being unable to publish events to endpoint

Webhook.endpoint ● String! non-null scalar​

Webhook endpoint. Must be valid https:// url

Webhook.id ● ID! non-null scalar​

Unique Identifier

Webhook.maxBatchDelayMs ● Int! non-null scalar​

Max delay (milliseconds) before partial batch is published

Webhook.maxBatchSize ● Int! non-null scalar​

Max number of events to publish at once

Webhook.name ● String! non-null scalar​

Webhook Name

Webhook.signatureSecret ● String scalar​

If provided, all requests will include an additional 'X-XY-Signature' header containing a HMAC sha256 hash of the (decompressed) message body. The supplied secret but be between 64 and 256 characters long and cannot be retrieved once set.

Webhook.updated ● Date! non-null scalar​

Last updated DateTime

Webhook.webhookType ● WebhookType! non-null enum​

Webhook Type enumerator

Returned By​

addWebhook mutation ● deleteWebhook mutation ● resetWebhookConsumer mutation ● resetWebhookMetrics mutation ● updateWebhook mutation ● webhook query ● webhooks query