Update a webhook

How to update an existing webhook via API

To update an existing webhook, send a PATCH request to the /api/webhooks/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/webhooks/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.topic

string

Optional

attributes.callback_url

string

Optional

attributes.include_resources

array

Optional

attributes._disable

boolean

Optional

attributes._enable

boolean

Optional

attributes._reset_circuit

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

Example

The following request updates the webhook identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "webhooks",
    "id": "xYZkjABcde",
    "attributes": {
      "include_resources": [
        "customer",
        "shipping_address",
        "billing_address"
      ]
    }
  }
}'

Last updated