Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1
Available options:
sandbox.ready,
sandbox.error,
sandbox.archived,
sandbox.hydrated
name
string | null
Required string length: 1 - 100

Response

Webhook created. Store the one-time signing secret now.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

webhook
object
required
secret
string
required

Signing secret returned only when created or rotated.

Pattern: ^whsec_[a-f0-9]{64}$