Skip to content
Notavia Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Start
Introduction
Quickstart
Authentication & environments
Core concepts
Guides
Sending email
Embed the in-app inbox
Webhooks
Workflows
Suppressions & delivery feedback
Configuring SSO
API
API Reference
API Reference
Overview
Notifications
Overview
List notifications with cursor pagination
Send a notification
Get a notification by id
Usage
Overview
Get current-period usage and plan limits
Templates
Overview
List templates with cursor pagination
Create a template
Get a template by key
Delete a template
Update fields on an existing template
Render a template with sample data (does not send)
Promote a template from Test to Live
Create or replace a channel body for a template
Delete a channel body from a template
Inbox
Overview
Verify an inbox JWT and return the resolved identity
Get the paginated in-app notification feed for the current user
Get a single inbox item
Mark an inbox item as read
Mark all inbox items as read (optionally scoped to a cutoff time)
Get the unread notification count for the current user
Preferences
Overview
List notification categories
Create a notification category
Update a notification category
Archive a notification category
Get effective preferences for a user
Bulk-upsert preference cells for a user
Set a single preference cell for a user
Webhooks
Overview
List webhook endpoints
Create a webhook endpoint
Get a webhook endpoint
Update a webhook endpoint
Delete (soft-disable) a webhook endpoint
Rotate the signing secret for a webhook endpoint
Send a test event to a webhook endpoint
List deliveries for a webhook endpoint
Get a single webhook delivery
Re-queue a webhook delivery for immediate retry
Suppressions
Overview
List suppressed addresses with cursor pagination
Manually add an address to the suppression list
Get a suppression by address
Remove an address from the suppression list
SMS
Overview
Get SMS provider settings for an environment
Create or update SMS provider settings for an environment
Delete SMS provider settings for an environment
Slack
Overview
Start the Slack OAuth 2.0 installation flow
Slack OAuth 2.0 callback — completes the installation
List Slack workspace installations for this environment
Get a Slack installation by id
Update settings on a Slack installation
Delete (revoke) a Slack installation
Send a test message via a Slack installation
Teams
Overview
List Microsoft Teams webhook endpoints
Create a Microsoft Teams webhook endpoint
Get a Teams endpoint by id
Update a Teams endpoint
Delete a Teams endpoint
Send a test Adaptive Card to a Teams endpoint
Discord
Overview
List Discord webhook endpoints
Create a Discord webhook endpoint
Get a Discord endpoint by id
Update a Discord endpoint
Delete a Discord endpoint
Send a test message to a Discord endpoint
Workflows
Overview
List all workflows in the environment
Create a new workflow
Get a workflow by key
Disable a workflow
List all versions of a workflow
Create a new draft version
Get a specific workflow version
Activate a draft version (or dry-run validate it)
Promote a workflow's active version from Test to Live
Trigger a workflow run
List runs for a workflow with cursor pagination
Post an event to all waiting runs of a workflow
Get a run with the full step timeline
Cancel an in-progress run
Post an event to a specific run
SDKs
SDKs
Changelog
Changelog
Select theme
Dark
Light
Auto
Overview
Usage
Section titled “Usage”
Current-period send usage and plan limits.
Operations
Section titled “ Operations ”
GET
/v1/usage
Privacy
Terms
Cookies
DPA
Subprocessors
Refunds
Legal Notice
Accessibility
Cookie preferences
