Skip to main content
POST
Create a webhook subscription

Authorizations

x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1
Available options:
vm.created,
vm.started,
vm.stopped,
vm.restarted,
vm.suspended,
vm.terminated,
vm.renewed,
billing.payment_received,
billing.low_balance,
ticket.reply
description
string
Maximum string length: 200

Response

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required