Retrieve a notification configuration

GET

https://api.modulards.com/api/public/v1/alerts/:alert_id

GET

/api/public/v1/alerts/:alert_id

curl https://api.modulards.com/api/public/v1/alerts/alert_id \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "attributes": {
      "created_at": "2026-09-20T09:00:00.000000Z",
      "discord_channel": false,
      "email_channel": true,
      "is_default": true,
      "name": "Operations",
      "sites_count": 1,
      "slack_channel": true,
      "status": "enabled",
      "updated_at": "2026-09-20T09:00:00.000000Z",
      "whatsapp_channel": false
    },
    "id": "12",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/alerts/12"
    },
    "relationships": {
      "contacts": {
        "data": [
          {
            "id": "7",
            "type": "contacts"
          }
        ]
      },
      "integrations": {
        "data": [
          {
            "id": "9",
            "type": "alert-integrations"
          }
        ]
      },
      "items": {
        "data": [
          {
            "id": "301",
            "type": "alert-items"
          }
        ]
      }
    },
    "type": "alerts"
  },
  "included": [
    {
      "attributes": {
        "status": "enabled",
        "type": "uptime.down"
      },
      "id": "301",
      "type": "alert-items"
    },
    {
      "attributes": {
        "created_at": "2026-09-18T10:00:00.000000Z",
        "type": "slack",
        "updated_at": "2026-09-18T10:00:00.000000Z",
        "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
      },
      "id": "9",
      "type": "alert-integrations"
    },
    {
      "attributes": {
        "company": null,
        "created_at": "2026-08-01T09:00:00.000000Z",
        "last_name": "Doe",
        "name": "Alice",
        "updated_at": "2026-08-01T09:00:00.000000Z"
      },
      "id": "7",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/contacts/7"
      },
      "type": "contacts"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  }
}

Returns one notification configuration with its event settings, its Slack and Discord destinations (with their complete URL) and the contacts it notifies, together with the number of websites it covers that your token can reach. Use include to narrow the answer to some of them.

Websites are added and removed explicitly with “Add websites to a notification configuration” and “Remove websites from a notification configuration”, never replaced as a whole selection.

Authentication

AuthorizationBearer

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

Path parameters

alert_idstringRequired

Query parameters

includestringOptional

Narrows the related data returned to the listed ones. Accepted: items, integrations and contacts, separated by commas. All three are returned when omitted.

Response

200 - Configuration

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional

Errors

404

Not Found Error