Skip to main content
View Markdown

Webhook Object

Webhook.

type Webhook implements Node {
  id: ID!
  name: String
  identifier: String
  events: [WebhookEvent!]! @deprecated
  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
  subscriptionQuery: String
  customHeaders: JSONString
}

Fields​

id ● ID!​

The ID of webhook.

name ● String​

The name of webhook.

identifier ● String​

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

Added in Saleor 3.23

syncEvents ● [WebhookEventSync!]!​

List of synchronous webhook events.

asyncEvents ● [WebhookEventAsync!]!​

List of asynchronous webhook events.

app ● App!​

The app associated with Webhook.

eventDeliveries ● EventDeliveryCountableConnection​

Event deliveries.

sortBy ● EventDeliverySortingInput​

Event delivery sorter.

filter ● EventDeliveryFilterInput​

Event delivery filter options.

before ● String​

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

after ● String​

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

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 ● 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 ● String!​

Target URL for webhook.

isActive ● Boolean!​

Informs if webhook is activated.

subscriptionQuery ● String​

Used to define payloads for specific events.

customHeaders ● JSONString​

Custom headers, which will be added to HTTP request.

Show deprecatedHide deprecated

events ● [WebhookEvent!]!​

DEPRECATED

Use asyncEvents or syncEvents instead.

List of webhook events.

secretKey ● String​

DEPRECATED

As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.

Used to create a hash signature for each payload.

Interfaces​

Node​

An object with an ID

Returned By​

webhook query

Member Of​

App object ● WebhookCreate object ● WebhookDelete object ● WebhookUpdate object