Skip to main content
POST
Create alert contact point

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
name
string
required

Name of the contact point, unique within the project.

integrations
object[]
required
Required array length: 1 - 100 elements
description
string
deliveryHours
object

A weekly schedule, used in two places. It is read in the project's timezone, looked up each time the schedule is checked, so changing the project's timezone moves the schedule along. Only an override's evaluationHours may set a timezone of their own. As a contact point's deliveryHours it is when the contact point's integrations may deliver. A notification that falls outside these hours is not sent, and not sent later either; the alert's state is recorded all the same. Omit on create to deliver at any time, omit on update to keep the current hours. As a rule's evaluationHours it is when the rule's alerts are evaluated at all. Outside these hours an alert gets no value, with noDataReason outside_evaluation_hours, and the no-data policy does not apply: a firing alert stays firing, a pending alert returns to normal so its for period starts again, and nothing is notified. Set on an override, it replaces the rule's hours for that alert and may set a timezone, e.g. Australia/Sydney for an alert on Australia; mode always evaluates that alert at any time. Omit to evaluate at any time (on an override: to inherit the rule's hours).

Response

Contact point created.

id
string
required

Alert contact point ID (format acp-<number>).

name
string
required
integrations
object[]
required
Maximum array length: 100
deliveryHours
object
required

A weekly schedule, used in two places. It is read in the project's timezone, looked up each time the schedule is checked, so changing the project's timezone moves the schedule along. Only an override's evaluationHours may set a timezone of their own. As a contact point's deliveryHours it is when the contact point's integrations may deliver. A notification that falls outside these hours is not sent, and not sent later either; the alert's state is recorded all the same. Omit on create to deliver at any time, omit on update to keep the current hours. As a rule's evaluationHours it is when the rule's alerts are evaluated at all. Outside these hours an alert gets no value, with noDataReason outside_evaluation_hours, and the no-data policy does not apply: a firing alert stays firing, a pending alert returns to normal so its for period starts again, and nothing is notified. Set on an override, it replaces the rule's hours for that alert and may set a timezone, e.g. Australia/Sydney for an alert on Australia; mode always evaluates that alert at any time. Omit to evaluate at any time (on an override: to inherit the rule's hours).

createdMs
integer<int64>
required
updatedMs
integer<int64>
required
description
string