Skip to main content
PATCH
Update webhook

Authorizations

Authorization
string
header
required

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

Path Parameters

webhookId
string
required
Pattern: ^wh_[a-f0-9]{24}$

Body

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

Response

Updated webhook metadata.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

webhook
object
required