VEXXHOSTDocumentation
API referenceNotification channels

Create a notification channel

POST
/v1/notification_channels

An email channel is sent a confirmation link and receives nothing until it is followed. A webhook channel is usable at once; its signing secret is in this response only.

Authorization

keystone
headerX-Auth-Token<token>

Request Body

application/json
  1. body
address?string

For an email channel: the address. It receives nothing until its owner follows the confirmation link sent to it.

Lengthlength <= 254
name*string
Length1 <= length <= 64
project_id?string

The owning project. Omitted, it is the caller's own project.

Lengthlength <= 255
type*string
Value in"email""webhook"
url?string

For a webhook channel: an https URL on a public address. Deliveries are signed; see X-Budget-Signature.

Lengthlength <= 2048

Response Body

Created

application/json
  1. response
address?string
created_at*string
Formatdate-time
created_by*string
id*string
name*string
project_id*string
secret?string

A webhook's signing secret. It is returned only when the channel is created and when the secret is rotated.

status*string
Value in"pending_confirmation""confirmed"
type*string
url?string
curl -X POST "https://example.com/v1/notification_channels" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "email"  }'
{  "address": "string",  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "id": "string",  "name": "string",  "project_id": "string",  "secret": "string",  "status": "pending_confirmation",  "type": "string",  "url": "string"}