POST
/
v1
/
webhooks
Create Bolt Webhook
curl --request POST \
  --url https://api.bolt.com/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "division_id": "3X9aPQ67-YrB",
  "url": "https://eva-nerv.shop.com/path/to/hook"
}
'
{
  "webhook_id": "wh_za7VbYcSQU2zRgGQXQAm-g"
}

Authorizations

​
X-API-Key
string
header
required

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Body

application/json

Webhook that receives notifications.

​
division_id
string
required

The unique ID associated with the specific merchant division.

Example:

"3X9aPQ67-YrB"

​
url
string
required

The full URL to receive webhook notifications.

Example:

"https://eva-nerv.shop.com/path/to/hook"

​
event_group
enum<string> | null

Subscribe to a group of events. all: subscribe to all existing and future event types

Available options:
all,
null

Response

Success

​
webhook_id
string
required

A unique webhook ID. Reference this value to modify or delete the webhook subscription. operations as well.

Example:

"wh_za7VbYcSQU2zRgGQXQAm-g"