WebhookCreateInput Input Type

input WebhookCreateInput {
  name: String
  identifier: String
  targetUrl: String
  events: [WebhookEventTypeEnum!] @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.")
  asyncEvents: [WebhookEventTypeAsyncEnum!]
  syncEvents: [WebhookEventTypeSyncEnum!]
  app: ID
  isActive: Boolean
  secretKey: String @deprecated(reason: "As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.")
  query: String
  customHeaders: JSONString
  payloadGeneration: WebhookPayloadGenerationEnum
}

Fields

name

name · String

The name of the webhook.

identifier

identifier · String

The unique identifier of the webhook, set by the app. Unique per app. Maximum length is 256 characters.

Added in Saleor 3.23

targetUrl

targetUrl · String

The url to receive the payload.

events

events · [WebhookEventTypeEnum!]

The events that webhook wants to subscribe.

asyncEvents

asyncEvents · [WebhookEventTypeAsyncEnum!]

The asynchronous events that webhook wants to subscribe.

syncEvents

syncEvents · [WebhookEventTypeSyncEnum!]

The synchronous events that webhook wants to subscribe.

app

app · ID

ID of the app to which webhook belongs.

isActive

isActive · Boolean

Determine if webhook will be set active or not.

secretKey

secretKey · String

The secret key used to create a hash signature with each payload.

query

query · String

Subscription query used to define a webhook payload.

Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only X-*, Authorization*, and BrokerProperties keys are allowed.

payloadGeneration

payloadGeneration · WebhookPayloadGenerationEnum

Determines when the subscription payload is built for asynchronous events that defer payload generation. Defaults to DEFERRED. 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

webhookCreate (mutations)

Schema: Saleor 3.23.43. Download SDL.