Skip to content
Notavia Notavia Docs

Overview

Notavia API 1.0.0

Section titled “Notavia API 1.0.0”

White-label notification engine. Authenticate with a bearer API key issued per environment. All /v1/* paths require Authorization: Bearer <api_key>.

The OAuth install/callback routes (/oauth/slack/*) require cookie authentication (dashboard session) rather than an API key.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/v1/notifications
POST
/v1/notifications
GET
/v1/notifications/{id}
GET
/v1/usage
GET
/v1/templates
POST
/v1/templates
GET
/v1/templates/{key}
DELETE
/v1/templates/{key}
PATCH
/v1/templates/{key}
POST
/v1/templates/{key}/render
POST
/v1/templates/{key}/promote
PUT
/v1/templates/{id}/bodies/{channel}
DELETE
/v1/templates/{id}/bodies/{channel}
POST
/inbox/v1/tokens/verify
GET
/inbox/v1/feed
GET
/inbox/v1/notifications/{id}
POST
/inbox/v1/notifications/{id}/read
POST
/inbox/v1/notifications/mark-all-read
GET
/inbox/v1/unread-count
GET
/v1/preferences/categories
POST
/v1/preferences/categories
PUT
/v1/preferences/categories/{key}
DELETE
/v1/preferences/categories/{key}
GET
/v1/preferences/users/{externalUserId}
PUT
/v1/preferences/users/{externalUserId}
PATCH
/v1/preferences/users/{externalUserId}/{categoryKey}/{channel}
GET
/v1/webhook-endpoints
POST
/v1/webhook-endpoints
GET
/v1/webhook-endpoints/{id}
PUT
/v1/webhook-endpoints/{id}
DELETE
/v1/webhook-endpoints/{id}
POST
/v1/webhook-endpoints/{id}/rotate-secret
POST
/v1/webhook-endpoints/{id}/send-test
GET
/v1/webhook-endpoints/{id}/deliveries
GET
/v1/webhook-endpoints/{id}/deliveries/{deliveryId}
POST
/v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry
GET
/v1/suppressions
POST
/v1/suppressions
GET
/v1/suppressions/{address}
DELETE
/v1/suppressions/{address}
GET
/v1/environments/{envId}/sms-settings
PUT
/v1/environments/{envId}/sms-settings
DELETE
/v1/environments/{envId}/sms-settings
GET
/oauth/slack/install
GET
/oauth/slack/callback
GET
/v1/slack/installations
GET
/v1/slack/installations/{id}
PUT
/v1/slack/installations/{id}
DELETE
/v1/slack/installations/{id}
POST
/v1/slack/installations/{id}/send-test
GET
/v1/teams-endpoints
POST
/v1/teams-endpoints
GET
/v1/teams-endpoints/{id}
PUT
/v1/teams-endpoints/{id}
DELETE
/v1/teams-endpoints/{id}
POST
/v1/teams-endpoints/{id}/send-test
GET
/v1/discord-endpoints
POST
/v1/discord-endpoints
GET
/v1/discord-endpoints/{id}
PUT
/v1/discord-endpoints/{id}
DELETE
/v1/discord-endpoints/{id}
POST
/v1/discord-endpoints/{id}/send-test
GET
/v1/workflows
POST
/v1/workflows
GET
/v1/workflows/{key}
DELETE
/v1/workflows/{key}
GET
/v1/workflows/{key}/versions
POST
/v1/workflows/{key}/versions
GET
/v1/workflows/{key}/versions/{n}
POST
/v1/workflows/{key}/versions/{n}/activate
POST
/v1/workflows/{key}/promote
POST
/v1/workflows/{key}/trigger
GET
/v1/workflows/{key}/runs
POST
/v1/workflows/{key}/events
GET
/v1/workflows/runs/{runId}
POST
/v1/workflows/runs/{runId}/cancel
POST
/v1/workflows/runs/{runId}/events

Authentication

Section titled “ Authentication ”

apiKey

Section titled “apiKey ”

API key issued per environment. Pass as Authorization: Bearer <key>.

Security scheme type: http

cookieAuth

Section titled “cookieAuth ”

Dashboard session cookie (used only by OAuth install/callback routes).

Security scheme type: apiKey

Cookie parameter name: .AspNetCore.Cookies

inboxJwt

Section titled “inboxJwt ”

Short-lived inbox JWT issued by POST /inbox/v1/tokens/verify.

Security scheme type: http