Create a webhook

How to create a webhook via API

To create a new webhook, send a POST request to the /api/webhooks endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/webhooks

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Optional, default is 'webhook {id}'
attributes.topic	string	Required
attributes.callback_url	string	Required
attributes.include_resources	array	Optional
attributes._disable	boolean	Optional
attributes._enable	boolean	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional

Example

Request

The following request creates a new webhook:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/webhooks' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "webhooks",
    "attributes": {
      "topic": "orders.place",
      "callback_url": "https://yourapp.com/webhooks"
    }
  }
}'

Response