Shops > Webhooks > webhooksModify
Commerce APIShopsWebhookswebhooksModify
webhooksModify
POST:webhooks.json

Description

Modify one or multiple webhook endpoints.

Permission bit: "webhooks.modify"

Topic: Webhooks

Arguments

data: [WebhookModify!]!

Main argument for mutations.


ids: [String!]!

List of webhook ids. See also: Unique Identifiers

Example: ["wh_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

enabled: Boolean

Whether this webhook is enabled or not

Example: true


url: String

Webhook endpoint URL

Example: "http://foobar.com/webhooks/app"

Valid when: url is not empty

Valid when: url's length doesn't exceed 250 characters


whitelist: [String!]

Send only these event types, when empty - send all


Result

[Webhook!]

Preview (typescript)

Loading module