REST API Reference

Messages

Send and manage notifications

POST/api/v1/messages

Create and send a new notification message. All fields are nested under the message object. Identify the recipient and template either by your own external_user_id / message_template_name, or by their internal IDs.

Request Body

message[external_user_id]String (Required unless message[notification_user_id] is given)
message[message_template_name]String (Required unless message[message_template_id] is given)
message[notification_user_id]Integer (Required unless message[external_user_id] is given)
message[message_template_id]Integer (Required unless message[message_template_name] is given)
message[message_attributes_attributes]Array of {name, value} objects (Optional)

GET/api/v1/messages/:id

Retrieve details of a specific message

PATCH/api/v1/messages/:id/mark_as_seen

Mark a specific message as seen

PATCH/api/v1/messages/:id/mark_as_delivered

Mark a specific message as delivered

GET/api/v1/messages/:id/render_message

Get the fully rendered subject and body of a message

GET/api/v1/messages/new_messages_for

Get all unseen messages for a specific user

Query Parameters

notification_user_idInteger (Required)

Notification Users

Manage notification users and retrieve their messages

GET/api/v1/notification_users

List all notification users for the account

GET/api/v1/notification_users/current

Get the notification user record for the currently authenticated user

GET/api/v1/notification_users/:id

Get a notification user by ID, including their associated contacts and channels

POST/api/v1/notification_users

Create a new notification user

Request Body

notification_user[first_name]String (Optional)
notification_user[middle_name]String (Optional)
notification_user[last_name]String (Optional)
notification_user[external_user_id]String (Optional)

PATCH/api/v1/notification_users/:id

Update an existing notification user

Request Body

notification_user[first_name]String (Optional)
notification_user[middle_name]String (Optional)
notification_user[last_name]String (Optional)
notification_user[external_user_id]String (Optional)

DELETE/api/v1/notification_users/:id

Delete a notification user

GET/api/v1/notification_users/:id/messages

Get all messages for a specific notification user

Message Templates

Manage notification templates

GET/api/v1/message_templates

List all message templates

POST/api/v1/message_templates

Create a new message template

Request Body

nameString (Required)
subject_templateString
body_templateString
category_idInteger

GET/api/v1/message_templates/:id

Retrieve details of a specific template

PATCH/api/v1/message_templates/:id

Update an existing message template

DELETE/api/v1/message_templates/:id

Delete a message template

Notification Channels

Manage notification delivery channels (email, SMS, etc.)

GET/api/v1/notification_channels

List all notification channels for the account

GET/api/v1/notification_channels/:id

Retrieve a specific notification channel by ID

POST/api/v1/notification_channels

Create a new notification channel

Request Body

notification_channel[name]String (Required)
notification_channel[channel_type]String (Required)
notification_channel[config]Object (Optional)
configuration key/value pairs (e.g. smtp_host, smtp_port, smtp_username, smtp_password, from_email, from_name, api_key)

PATCH/api/v1/notification_channels/:id

Update an existing notification channel

Request Body

notification_channel[name]String (Optional)
notification_channel[channel_type]String (Optional)
notification_channel[config]Object (Optional)

DELETE/api/v1/notification_channels/:id

Delete a notification channel

POST/api/v1/notification_channels/:id/test_configuration

Send a test message using the channel's configuration

Request Body

test_emailString (Optional)
recipient address for the test; defaults to the authenticated user's email

Channel Tokens

Generate short-lived tokens for authenticating real-time channel connections

POST/api/v1/channel_tokens

Generate a signed channel token for a notification user, valid for 1 hour

Request Body

external_user_idString (Required)

User Invites

Manage account user invitations

GET/api/v1/user_invites

List all pending invitations

POST/api/v1/user_invites

Invite a new user to the account

Request Body

emailString (Required)
roleString (e.g., admin, member)

PATCH/api/v1/user_invites/:id/renew

Resend/renew an invitation

DELETE/api/v1/user_invites/:id

Revoke an invitation

Feature Votes

Manage community feature voting

GET/api/v1/feature_votes

List all feature votes

POST/api/v1/feature_votes

Vote for a feature

Request Body

feature_keyString (Required)

DELETE/api/v1/feature_votes/:feature_key

Remove a vote

Analytics

Insightful data about notifications

GET/api/v1/analytics/message_templates/recent_notifications

Get recent notification stats for templates

Resources

Messages

Request Body

Query Parameters

Notification Users

Request Body

Request Body

Message Templates

Request Body

Categories

Request Body

Request Body

Notification Channels

Request Body

Request Body

Request Body

Channel Tokens

Request Body

User Invites

Request Body

Feature Votes

Request Body

Analytics