Skip to main content
POST
Create webhook

Authorizations

X-API-Key
string
header
required

Body

application/json

Configuration for registering new webhooks

name
string
required
url
string<uri>
required
events
enum<string>[]
required
Available options:
sandbox.lifecycle.created,
sandbox.lifecycle.killed,
sandbox.lifecycle.paused,
sandbox.lifecycle.resumed,
sandbox.lifecycle.updated,
sandbox.lifecycle.checkpointed
Example:
signatureSecret
string
required

Secret used to sign the webhook payloads

Minimum string length: 32
Example:

"replace-with-your-random-signing-secret"

enabled
boolean
default:true

Response

Successfully created webhook.

Webhook creation response

id
string
required

Webhook unique identifier

name
string
required

Webhook user friendly name

createdAt
string<date-time>
required

Time when the template was created

teamId
string
required

Unique identifier for the team

url
string<uri>
required
enabled
boolean
required
events
string[]
required