API reference
notifications
17 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| GET | /v1/notification-connections | Connected destinations and the routing matrix. | Any API key |
| POST | /v1/notification-connections | Connect a destination. | Any API key |
| GET | /v1/notification-connections/confirm | What a confirmation link is asking. | No API key |
| POST | /v1/notification-connections/confirm | Confirm you want an organisation's notifications at this address. | No API key |
| DELETE | /v1/notification-connections/{connection_id} | Disconnect a destination. | Any API key |
| POST | /v1/notification-connections/{connection_id}/verify | Send a real test message to a destination. | Any API key |
| GET | /v1/notification-preferences | What you want to hear about, by topic. | Any API key |
| PUT | /v1/notification-preferences | Turn a topic's mail on or off. | org.update |
| PUT | /v1/notification-routes | Turn a notification topic on or off for one destination. | Any API key |
| DELETE | /v1/outbound-mail | Remove this organisation's own mail service. | connections.manage |
| GET | /v1/outbound-mail | The mail service this organisation sends through. | org.read |
| PUT | /v1/outbound-mail | Attach or replace this organisation's own mail service. | connections.manage |
| POST | /v1/outbound-mail/test | Send a real message through your provider, carrying a one-time code. | connections.manage |
| POST | /v1/outbound-mail/verify | Enter the code from the test message. | connections.manage |
| GET | /v1/sites/{site_id}/notification-channels | Which channels this site's notifications go to. | Any API key |
| PUT | /v1/sites/{site_id}/notification-channels | Replace this site's notification channels. | Any API key |
| POST | /v1/webhooks/demo-budget | A hands-on demo site reports that one of its AI budgets ran out. | No API key |