Skip to main content
View Markdown

WebhookUpdateInput Input Type

No description

input WebhookUpdateInput {
  name: String
  identifier: String
  targetUrl: String
  events: [WebhookEventTypeEnum!] @deprecated
  asyncEvents: [WebhookEventTypeAsyncEnum!]
  syncEvents: [WebhookEventTypeSyncEnum!]
  app: ID
  isActive: Boolean
  secretKey: String @deprecated
  query: String
  customHeaders: JSONString
}

Fields​

name ● String​

The new name of the webhook.

identifier ● String​

The unique identifier of the webhook, set by the app. Unique per app. Maximum length is 256 characters. Pass a blank value to clear it.

Added in Saleor 3.23

targetUrl ● String​

The url to receive the payload.

asyncEvents ● [WebhookEventTypeAsyncEnum!]​

The asynchronous events that webhook wants to subscribe.

syncEvents ● [WebhookEventTypeSyncEnum!]​

The synchronous events that webhook wants to subscribe.

app ● ID​

ID of the app to which webhook belongs.

isActive ● Boolean​

Determine if webhook will be set active or not.

query ● String​

Subscription query used to define a webhook payload.

customHeaders ● JSONString​

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.

Show deprecatedHide deprecated

events ● [WebhookEventTypeEnum!]​

DEPRECATED

Use asyncEvents or syncEvents instead.

The events that webhook wants to subscribe.

secretKey ● String​

DEPRECATED

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

Use to create a hash signature with each payload.

Member Of​

webhookUpdate mutation