Create a notification configuration
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(enabledordisabled, 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 answers404.items(array, optional): entries of{type, status}, wheretypeis a notification event andstatusisenabledordisabled. The events areuptime.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-foundandbroken-link.issues-found. Each type appears once.
Errors
- 422:
vulnerability.discovered.criticalis enabled whilevulnerability.discoveredis 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_channel
items
name
Response headers
Location
Response
201 Created
data
jsonapi
Errors
422
Unprocessable Entity Error
