Webhook Object

Webhook.

type Webhook implements Node {
  id: ID!
  name: String
  identifier: String
  events: [WebhookEvent!]! @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.")
  syncEvents: [WebhookEventSync!]!
  asyncEvents: [WebhookEventAsync!]!
  app: App!
  eventDeliveries(sortBy: EventDeliverySortingInput, filter: EventDeliveryFilterInput, before: String, after: String, first: Int, last: Int): EventDeliveryCountableConnection
  targetUrl: String!
  isActive: Boolean!
  secretKey: String @deprecated(reason: "As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.")
  subscriptionQuery: String
  customHeaders: JSONString
  payloadGeneration: WebhookPayloadGenerationEnum!
}

Fields

name

name · String

The name of webhook.

identifier

identifier · String

The unique identifier of the webhook, set by the app. Unique per app, null when not set.

Added in Saleor 3.23

events

events · [WebhookEvent!]!

List of webhook events.

syncEvents

syncEvents · [WebhookEventSync!]!

List of synchronous webhook events.

asyncEvents

asyncEvents · [WebhookEventAsync!]!

List of asynchronous webhook events.

app

app · App!

The app associated with Webhook.

eventDeliveries

eventDeliveries · EventDeliveryCountableConnection

Event deliveries.

sortBy

sortBy · EventDeliverySortingInput

Event delivery sorter.

filter

filter · EventDeliveryFilterInput

Event delivery filter options.

before

before · String

Return the elements in the list that come before the specified cursor.

after

after · String

Return the elements in the list that come after the specified cursor.

first

first · Int

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last

last · Int

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

targetUrl

targetUrl · String!

Target URL for webhook.

isActive

isActive · Boolean!

Informs if webhook is activated.

secretKey

secretKey · String

Used to create a hash signature for each payload.

subscriptionQuery

subscriptionQuery · String

Used to define payloads for specific events.

customHeaders

customHeaders · JSONString

Custom headers, which will be added to HTTP request.

payloadGeneration

payloadGeneration · WebhookPayloadGenerationEnum!

Determines when the subscription payload is built for asynchronous events that defer payload generation. Ignored for webhooks without a subscription query, for synchronous events and for events that do not defer their payload.

Added in Saleor 3.23

Used by

Schema: Saleor 3.23.43. Download SDL.