Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

An organization API key (bg_live_…), created in BrandGate under Settings → Developers.

Body

application/json
url
string<uri>
required
Maximum string length: 2000
events
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
order.created,
order.updated,
invoice.created,
invoice.updated,
product.stock_low
description
string
Maximum string length: 200

Response

Success.

id
string<uuid>
required
object
any
required
url
string<uri>
required
events
enum<string>[]
required
Available options:
order.created,
order.updated,
invoice.created,
invoice.updated,
product.stock_low
description
string | null
required
Maximum string length: 200
status
enum<string>
required
Available options:
enabled,
disabled
disabled_reason
string | null
required
Maximum string length: 200
created_at
string<date-time>
required
secret
string
required
Pattern: ^whsec_[A-Za-z0-9_-]{43}$