WebhookUpdateInput Input Type
No description
input WebhookUpdateInput {
name: String
targetUrl: String
events: [WebhookEventTypeEnum!] @deprecated
asyncEvents: [WebhookEventTypeAsyncEnum!]
syncEvents: [WebhookEventTypeSyncEnum!]
app: ID
isActive: Boolean
secretKey: String @deprecated
query: String
customHeaders: JSONString
}
Fields
WebhookUpdateInput.name
● String
scalar miscellaneous
The new name of the webhook.
WebhookUpdateInput.targetUrl
● String
scalar miscellaneous
The url to receive the payload.
WebhookUpdateInput.events
● [WebhookEventTypeEnum!]
deprecated list enum webhooks
DEPRECATED
Use asyncEvents
or syncEvents
instead.
The events that webhook wants to subscribe.
WebhookUpdateInput.asyncEvents
● [WebhookEventTypeAsyncEnum!]
list enum webhooks
The asynchronous events that webhook wants to subscribe.
WebhookUpdateInput.syncEvents
● [WebhookEventTypeSyncEnum!]
list enum webhooks
The synchronous events that webhook wants to subscribe.
WebhookUpdateInput.app
● ID
scalar miscellaneous
ID of the app to which webhook belongs.
WebhookUpdateInput.isActive
● Boolean
scalar miscellaneous
Determine if webhook will be set active or not.
WebhookUpdateInput.secretKey
● String
deprecated scalar miscellaneous
DEPRECATED
As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
Use to create a hash signature with each payload.
WebhookUpdateInput.query
● String
scalar miscellaneous
Subscription query used to define a webhook payload.
WebhookUpdateInput.customHeaders
● JSONString
scalar miscellaneous
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.
Member Of
webhookUpdate
mutation