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
}

Fields

name (String)

The new name of the webhook.

targetUrl (String)

The url to receive the payload.

events ([WebhookEventTypeEnum!])

The events that webhook wants to subscribe.

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

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.

secretKey (String)

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.

query (String)

Subscription query used to define a webhook payload.

Added in Saleor 3.2.

Note: this API is currently in Feature Preview and can be subject to changes at later point.