Courier

Courier is notification infrastructure: you send one notification to a recipient and Courier fans it out to email, SMS or a chat provider using the addresses stored on that recipient's profile.

Authentication

• API key

Actions

Generic API request. Call any Courier API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

• Get messageRetrieve a single message status record by id (GET /messages/{messageId}).
• Get profileRead the stored Courier recipient profile for a user id — the addresses and preferences Courier will use when a notification is sent to that user.
• List listsList the Courier notification lists — the named audiences a message can be sent to instead of a single recipient.
• List messagesList messages with optional cursor pagination and status filter (GET /messages).
• Merge profileDestructiveMerge attributes into a recipient profile (POST /profiles/{userId}, application/json).
• Send messageSend a notification via the Courier Send API (POST /send, application/json).

Triggers

• Message status updated (webhook)Starts when a message Courier is delivering changes status (enqueued, sent, delivered, or failed), delivered by a webhook instead of polling message history.
• New messageStarts when Courier enqueues a new message, detected by its enqueued timestamp advancing past the stored cursor on each poll.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.