Skip to main content
POST
/
api
/
public
/
v1
/
webhooks
Create a webhook subscription
curl --request POST \
  --url https://api.vmarea.com/api/v1/api/public/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [],
  "description": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "isActive": true,
    "description": "<string>",
    "failCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

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