Skip to main content

Webhook

Webhook.

type Webhook implements Node {
  id: ID!
  name: 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​

Webhook.id ● ID! non-null scalar​

Webhook.name ● String! non-null scalar​

Webhook.events ● [WebhookEvent!]! deprecated non-null object​

DEPRECATED

This field will be removed in Saleor 4.0. Use asyncEvents or syncEvents instead.

List of webhook events.

Webhook.syncEvents ● [WebhookEventSync!]! non-null object​

List of synchronous webhook events.

Webhook.asyncEvents ● [WebhookEventAsync!]! non-null object​

List of asynchronous webhook events.

Webhook.app ● App! non-null object​

Webhook.eventDeliveries ● EventDeliveryCountableConnection object​

Event deliveries.

Webhook.eventDeliveries.sortBy ● EventDeliverySortingInput input​

Event delivery sorter.

Webhook.eventDeliveries.filter ● EventDeliveryFilterInput input​

Event delivery filter options.

Webhook.eventDeliveries.before ● String scalar​

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

Webhook.eventDeliveries.after ● String scalar​

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

Webhook.eventDeliveries.first ● Int scalar​

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

Webhook.eventDeliveries.last ● Int scalar​

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

Webhook.targetUrl ● String! non-null scalar​

Target URL for webhook.

Webhook.isActive ● Boolean! non-null scalar​

Informs if webhook is activated.

Webhook.secretKey ● String deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.

Used to create a hash signature for each payload.

Webhook.subscriptionQuery ● String scalar​

Used to define payloads for specific events.

Webhook.customHeaders ● JSONString scalar​

Custom headers, which will be added to HTTP request.

Added in Saleor 3.12
This API is currently in Feature Preview and can be subject to changes at later point.

Interfaces​

Node interface​

An object with an ID

Returned by​

webhook query

Member of​

App object ● WebhookCreate object ● WebhookDelete object ● WebhookUpdate object

Was this page helpful?