Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Pass your API key as: Authorization: Bearer <API KEY>.

User-Agent
string
header
default:BosscartDocs/1.0
required

Client identifier sent with requests from the documentation playground.

Body

application/json
target
string<uri>
required
Example:

"https://your-target.com/some-path"

events
enum<string>[]
required
Available options:
order_created,
order_updated,
product_created,
product_updated,
form_submitted,
contact_updated,
booking_created
Example:
secret
string
Example:

"your-secret"

Response

200 - application/json

The created webhook.

id
string

Unique identifier.

Example:

"rh_24488493954"

target
string<uri>

Your destination URL to push notifications to.

Example:

"https://your-target.com/some-path"

secret
string

Use the secret to verify that events posted to your URL were sent by the website.

Example:

"your-secret"

events
enum<string>[]
Available options:
order_created,
order_updated,
product_created,
product_updated,
form_submitted,
contact_updated,
booking_created
Example:
Last modified on September 2, 2026