Skip to main content
Version: 3.x

WebhookUpdateInput

No description

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

Fields​

WebhookUpdateInput.name ● String scalar​

The new name of the webhook.

WebhookUpdateInput.targetUrl ● String scalar​

The url to receive the payload.

WebhookUpdateInput.events ● [WebhookEventTypeEnum!] list enum​

The events that webhook wants to subscribe.

DEPRECATED: this field will be removed in Saleor 4.0. Use asyncEvents or syncEvents instead.

WebhookUpdateInput.asyncEvents ● [WebhookEventTypeAsyncEnum!] list enum​

The asynchronous events that webhook wants to subscribe.

WebhookUpdateInput.syncEvents ● [WebhookEventTypeSyncEnum!] list enum​

The synchronous events that webhook wants to subscribe.

WebhookUpdateInput.app ● ID scalar​

ID of the app to which webhook belongs.

WebhookUpdateInput.isActive ● Boolean scalar​

Determine if webhook will be set active or not.

WebhookUpdateInput.secretKey ● String scalar​

Use to create a hash signature with each payload.

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

WebhookUpdateInput.query ● String scalar​

Subscription query used to define a webhook payload.

Added in Saleor 3.2

WebhookUpdateInput.customHeaders ● JSONString scalar​

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-" and "Authorization" keys are allowed.

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

Member of​

webhookUpdate mutation

Was this page helpful?