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.
PATCH https://yourdomain.commercelayer.io/api/webhooks/:id
Body Parameter | Type | Required |
|---|---|---|
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._reset_circuit | boolean | Optional |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
Request
Response
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"
]
}
}
}'
On success, the API responds with a
200 OK status code, returning the updated resource object:{
"data": {
"id": "xYZkjABcde",
"type": "webhooks",
"links": {
"self": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde"
},
"attributes": {
"name": "myorg-orders.place",
"topic": "orders.place",
"callback_url": "https://yourapp.com/webhooks",
"include_resources": [
"customer",
"shipping_address",
"billing_address"
],
"circuit_state": "closed",
"circuit_failure_count": 5,
"shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"last_event_callbacks": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/relationships/last_event_callbacks",
"related": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/last_event_callbacks"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/webhooks/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 29d ago