notification

Create a notification

Changed on Sep 11, 2026

post/notification

Request

Base URL
https://api.openstatus.dev (the document declares no server; this is the origin it was published from)
Auth
API key in header x-openstatus-key

Request body

namestring required

The name of the notification

provider'discord' | 'email' | 'google-chat' | 'grafana-oncall' | 'ms-teams' | 'ntfy' | 'pagerduty' | 'opsgenie' | 'slack' | 'sms' | 'telegram' | 'webhook' | 'whatsapp' required

The provider of the notification. sms is deprecated, use whatsapp instead.

payloadunknown

monitorsnumber[] nullable

The monitors that the notification is linked to

Example request

{
  "name": "OpenStatus Discord",
  "provider": "discord",
  "monitors": [
    1,
    2
  ]
}

Response

Return the created notification

idnumber required

The id of the notification

namestring required

The name of the notification

provider'discord' | 'email' | 'google-chat' | 'grafana-oncall' | 'ms-teams' | 'ntfy' | 'pagerduty' | 'opsgenie' | 'slack' | 'sms' | 'telegram' | 'webhook' | 'whatsapp' required

The provider of the notification. sms is deprecated, use whatsapp instead.

payloadunknown

monitorsnumber[] nullable

The monitors that the notification is linked to

Example response

{
  "id": 1,
  "name": "OpenStatus Discord",
  "provider": "discord",
  "monitors": [
    1,
    2
  ]
}

Changes

Sep 11, 2026a3ef7e6cc6ac Revision changes
- breaking
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 from the request property anyOf list
- breaking
  the response property became nullable for the status
- breaking
  the response property became optional for the status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new SERVICE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- warning
  added the new TOO_MANY_REQUESTS enum value to the response property for the response status
- info
  the request property became nullable
- info
  the request property became optional
- info
  added the new ms-teams enum value to the request property
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 subschema #12 subschema #13 from the response property anyOf list for the response status

Operation history