OBJECT

Webhook

Returns the webhooks linked to marketplacer events.

link GraphQL Schema definition

  • type Webhook implements Node {
  • # Allow Skip? (With this enabled, identical payloads will be skipped)
  • allowSkip: Boolean
  • # Maximum number of events we will attempt to deliver for this webhook at a time.
  • concurrentSendLimit: Int!
  • # Activate webhook? (true/false)
  • enabled: Boolean
  • # Additional event filter that allows you to specify the type of event traffic
  • # generated, e.g. Create, Update and Destroy. If not specified all events will be
  • # sent
  • eventName: WebhookEventEnum
  • # Webhook events
  • events: [WebhookEvent!]
  • # Optional headers supplied as JSON that can be used to access further configure
  • # webhook HTTP POST requests (e.g. { Authorization: "Basic x123" })
  • headers: JSON
  • id: ID!
  • # Set to false to enable the use of additional error reporting in webhook
  • # payloads, or false if you want to retain the legacy format for payloads with no
  • # error reporting.
  • legacyFormat: Boolean
  • # Maximum number of times we will retry sending each event.Note that we will stop
  • # after 30 days regardless of the number of retry attempts.
  • maxRetries: Int!
  • # Optional GraphQL query that can be used to determine the result will be sent
  • # when the Webhook is triggered. If left blank, the Webhook will return a default
  • # query (e.g. "query($id: ID!){ node(id: $id) { __typename } }")
  • queryString: String
  • seller: Seller
  • # The name of the Marketplacer object that webhook events are being generated for
  • type: WebhookKlassEnum!
  • # External URL listening for incoming HTTP POST
  • url: String!
  • }