Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

An API key that starts with vms_. Make one in Settings > API keys.

Headers

vms-event-id
string
required

The ID of the event. A retry has the same ID.

Example:

"evt_06d8k3m7q2v9x4b1n5c0e8f2ja"

vms-event-type
string
required
Example:

"sandbox.running"

vms-timestamp
string
required

The time of this attempt, in seconds since 1970-01-01 UTC.

Example:

"1794795278"

vms-signature
string
required

v1= and the hex HMAC-SHA256 of .., with the secret of the endpoint as the key.

Example:

"v1=c026a0fa99a8f351a2bb213ba255ef2059be454e011f86144611bad787b51e53"

Body

application/json

The body of each webhook request.

id
string
required
Example:

"evt_06d8k3m7q2v9x4b1n5c0e8f2ja"

type
enum<string>
required

The kind of change that an event reports.

Available options:
sandbox.running,
sandbox.stopped,
sandbox.error,
sandbox.degraded,
sandbox.recovered,
sandbox.deleted,
sandbox.failed,
sandbox.hydrated
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
data
object
required

Response

200

Your endpoint got the event.