Skip to content

Creates alert channel
Stable

Request

Creates a new alert channel in the enterprise, defining a notification destination to be used when alarm rules are triggered. Alert channels are prerequisites for alarm rules — a channel must exist before it can be linked to any rule. Currently, email is the supported delivery type.

Workflow

Create an alert channel using this endpoint → receive a channel id in the response

Use that id when creating or updating an alarm rule via POST /v1/enterprise/{enterprise_id}/alarmrules/ to link the channel as a notification destination

Common use cases

Setting up a new email destination for device or fleet alert notifications

Creating dedicated channels for different teams (e.g., a channel for ops, another for IT support) so alarm rules can target the appropriate recipients

Programmatically provisioning notification infrastructure as part of an enterprise onboarding workflow

Best practices

Use a descriptive name that makes the channel's purpose and recipient clear (e.g., "IT Ops - Device Offline Alerts") — this is how channels are identified in the Console and when auditing via GET /alertchannels/

Store the integer id from the 201 response — it is required for all subsequent operations on this channel and for linking it to alarm rules

A channel can be linked to multiple alarm rules; create shared channels for common recipients rather than duplicating channels per rule

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

Bodyapplication/jsonrequired
idinteger
propertiesobject
namestring
typestring

format of alert. e.g. email

created_onstring, (date-time)
updated_onstring, (date-time)
enterprisestring, (uuid)
cURL
curl -i -X POST \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/alertchannels/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "properties": {
      "to_address": "user@example.com"
    },
    "name": "string",
    "type": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
  }'

Responses

successful operation

Bodyapplication/json
idinteger
propertiesobject
namestring
typestring

format of alert. e.g. email

created_onstring, (date-time)
updated_onstring, (date-time)
enterprisestring, (uuid)
linked_alertsArray of strings
Response
{ "id": 0, "properties": { "to_address": "user@example.com" }, "name": "string", "type": "string", "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z", "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9", "linked_alerts": [ "string" ] }