Skip to navigation

Create a notification configuration

View as MarkdownOpen in Claude

Creates a notification configuration with no websites and no contacts. Use it to define which events you want to be told about and through which channels, then add websites and contacts to it.

Sending an event as a key, such as "uptime.down": true, is rejected as an unknown field: events go in items.

Body

  • name (string, required): at most 30 characters.
  • default (boolean, optional): makes it the organization’s default configuration.
  • status (enabled or disabled, optional): whether the configuration is active.
  • email_channel, whatsapp_channel, slack_channel, discord_channel (boolean, optional): which channels are active. Email is always available. WhatsApp, Slack and Discord depend on the organization’s plan: the request is accepted whatever the plan, but a notification goes out through one of them only while the plan includes it, and Slack and Discord also need a saved destination. Saving, deleting or testing a Slack or Discord destination on a plan without that channel answers 404.
  • items (array, optional): entries of {type, status}, where type is a notification event and status is enabled or disabled. The events are uptime.down, uptime.up, uptime.ssl.expiration, backup.failed, site.connection-lost, patchstack.connection-lost, report.automatic.failed, vulnerability.discovered, vulnerability.discovered.critical, administrator.added, administrator.removed, malware-scan.threats-found and broken-link.issues-found. Each type appears once.

Errors

  • 422: vulnerability.discovered.critical is enabled while vulnerability.discovered is not enabled, in the same call or already stored.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Request

This endpoint expects an object.
email_channelbooleanOptional
itemslist of objectsOptional
namestringOptional

Response headers

LocationstringOptional

Response

201 Created
dataobjectOptional
jsonapiobjectOptional

Errors

422
Unprocessable Entity Error