Skip to content

Create an alert contact

POST
/api/v1/alert-contacts

Creates a new alert contact for the authenticated user.

Request body for creating a new alert contact.

object
name
required

Human-readable label.

string
Example
Ops Team Email
type
required

Notification channel type.

string
Allowed values: email slack webhook
Example
email
value
required

Channel address.

string
Example
ops@example.com
Examples

Email contact

{
"name": "Ops Team",
"type": "email",
"value": "ops@example.com"
}

Alert contact created successfully.

A contact channel for receiving alerts.

object
id
required

Unique alert contact identifier.

integer
Example
1
user_id
required

ID of the user who owns this contact.

integer
Example
1
type
required

Notification channel type.

string
Allowed values: email slack webhook
Example
email
value
required

Channel address (email, Slack webhook URL, or webhook URL).

string
Example
ops@example.com
name
required

Human-readable label for this contact.

string
Example
Ops Team Email
verified

Whether the contact has been verified. Email contacts require verification before receiving alerts. Slack and webhook contacts are verified automatically.

boolean
Example
true
created_at
required

When the contact was created.

string format: date-time
Example
2026-01-10T09:00:00Z

The request body is invalid or missing required fields.

Error response returned when a request fails.

object
error
required

A human-readable error message.

string
Example
monitor not found
Example
{
"error": "invalid request body"
}

Authentication credentials are missing or invalid.

Error response returned when a request fails.

object
error
required

A human-readable error message.

string
Example
monitor not found
Example
{
"error": "unauthorized"
}