// customize
const inkeepSettings = {
  baseSettings: {
    apiKey: "88b123179062d30ee3fe5a5161fd01aecaffe0426ef95f4a", // required
    integrationId: "cm2uo47kh00d5xtuaeqkur3u1", // required
    organizationId: "org_mJdpWbLsGPeOwwPd", // required
    primaryBrandColor: "#3E2A49", // required -- your brand color, the color scheme is derived from this
    organizationDisplayName: "Courier",
    theme: {
      tokens: {
        colors: {
          "gray.600": "#6b7278",
        },
      },
    },
    // ...optional settings
  },
  aiChatSettings: {
    chatSubjectName: "Courier",
    botAvatarSrcUrl:
      "https://framerusercontent.com/images/UaLJKrAmvdMARtdLOIVEDfj5vuQ.svg",
    getHelpCallToActions: [
      {
        name: "GitHub",
        url: "https://github.com/trycourier",
        icon: { builtIn: "FaGithub" },
      },
      {
        name: "Discord",
        url: "https://discord.gg/courier",
        icon: { builtIn: "FaDiscord" },
      },
    ],
    quickQuestions: [
      "How to create and send an email notification?",
      "How to setup a template approval workflow?",
      "Inserting data with variables?",
      "Set up a webhook destination?",
    ],
  },
  modalSettings: {
    // isShortcutKeyEnabled: false, // disable default cmd+k behavior
    // ...optional settings
  },
};

// The Mintlify search triggers, which we'll reuse to trigger the Inkeep modal
const searchButtonContainerIds = [
  "search-bar-entry",
  "search-bar-entry-mobile",
];

// Clone and replace, needed to remove existing event listeners
const clonedSearchButtonContainers = searchButtonContainerIds.map((id) => {
  const originalElement = document.getElementById(id);
  const clonedElement = originalElement.cloneNode(true);
  originalElement.parentNode.replaceChild(clonedElement, originalElement);

  return clonedElement;
});

// Load the Inkeep component library
const inkeepScript = document.createElement("script");
inkeepScript.type = "module";
inkeepScript.src = "https://unpkg.com/@inkeep/uikit-js@0.3.18/dist/embed.js";
document.body.appendChild(inkeepScript);

// Once the Inkeep library is loaded, instantiate the UI components
inkeepScript.addEventListener("load", function () {
  // Customization settings

  // for syncing with dark mode
  const colorModeSettings = {
    observedElement: document.documentElement,
    isDarkModeCallback: (el) => {
      return el.classList.contains("dark");
    },
    colorModeAttribute: "class",
  };

  // Instantiate the 'Ask AI' pill chat button. Optional.
  Inkeep().embed({
    componentType: "ChatButton",
    colorModeSync: colorModeSettings,
    properties: inkeepSettings,
  });

  // Instantiate the search bar modal
  const inkeepSearchModal = Inkeep({
    ...inkeepSettings.baseSettings,
  }).embed({
    componentType: "CustomTrigger",
    colorModeSync: colorModeSettings,
    properties: {
      ...inkeepSettings,
      isOpen: false,
      onClose: () => {
        inkeepSearchModal.render({
          isOpen: false,
        });
      },
    },
  });

  // When the Mintlify search bar elements are clicked, open the Inkeep search modal
  clonedSearchButtonContainers.forEach((trigger) => {
    trigger.addEventListener("click", function () {
      inkeepSearchModal.render({
        isOpen: true,
      });
    });
  });

  // Open the Inkeep Modal with cmd+k
  window.addEventListener(
    "keydown",
    (event) => {
      if (
        (event.metaKey || event.ctrlKey) &&
        (event.key === "k" || event.key === "K")
      ) {
        event.stopPropagation();
        inkeepSearchModal.render({ isOpen: true });
        return false;
      }
    },
    true
  );
});


Courier

Integrations

API Reference

SDK Libraries

Tutorials

Help

Sign Up

Request demo

Login

Get Users in Tenant

Additional metadata to be applied to a user profile when used in a tenant context

Tenant ID for the assocation between tenant and user

User ID for the assocation between tenant and user

UserTenantAssociation

BearerAuth

ListUsersForTenantResponse

BadRequest

Find all the tutorials and resources you need to build product notifications with Courier.

Home

Welcome to the Courier Documentation

Courier lets you design your notifications once and deliver them to any channel-push notifications, direct messages, SMS, and email-with a single [Courier API](/reference/intro) rather than having to integrate each provider API separately.

What is Courier?

Courier terms and concepts you will commonly see when you use Courier's notification platform.

Courier Concepts

This quickstart demonstrates how to send messages from a Node.js application.

Quickstart

Node.js Quickstart

Overview

An overview of Courier automation features, its core concepts and example use cases.

How to Understand Automation Concepts

A walkthrough on how to send Courier Automations through an ad-hoc API request, or template.

How To Send Automations

Learn how to send browser and mobile push notifications using Segment and Courier.

How To Send Notifications With Segment

Design Your First Notification Template

Learn how to use Courier's AI content generator to build and iterate on notification content rapidly.

How to Use AI to Build Notifications

Learn how to give your email notifications a consistent look and feel for you and your customers.

How to Use Brands to Customize Email Notifications

Learn how to incrementally build a notification that goes out to a very large number of users and then execute the send with a single API call.

How To Send Bulk Notifications

Learn how to structure the List IDs you create via the Lists API according to the pattern guidelines that enable wildcard sending.

How To Create And Send To A List Or List Pattern

This how to guide walks through triggering a product notification send using the Courier Send API or the Segment integration.

How To Send A Product Notification

How to Send a One-Time Notification

This how to guide walks you through sending a notification with Courier.

How To Send Your First Message

This how to guide walks you through configuring multi-channel routing for your product notifications with Courier.

How To Configure Multi-Channel Routing

Courier Users

Courier uses the term `user` to describe the recipient of a notification.

Users

There are two ways that developers can construct the content of the notifications that they send:

Introduction

Content

The Asset Manager is a new way to organize assets in Courier. The Asset Manager can be used to organize your automation, message, and shared content templates.

Asset Manager

Checks System

When formatting emails in HTML, it's important to consider the compatibility across different email clients, as some may not support certain CSS styles or HTML tags.

Email Safe Formatting

Learn how Courier helps with content internationalization for browser, email and push notifications.

Internationalization Specification

Learn how to build an approval workflow for publishing templates

Template Approval Workflow

This step-by-step guide will walk you through creating and sending an email notification using Courier.

Create and Send an Email Notification

Create and Map Events to Trigger Notifications

The Channel Settings contain important configurations that allow you to define if and when the Channel will send to users or be disabled. You can also add integrations and order the send priority when there are multiple integrations in a channel. Channel and integration-specific settings are here as well.

Channel Settings

Send Priority Rules

Courier's business tier customers get access to Send Limits, which lets you set upper limits on the number of messages that can be sent per time period.

Send Limits

Courier employs a robust retry mechanism to ensure reliable notification/webhook delivery and accurate status tracking, even in the event of temporary downstream failures or network issues.

Delivery Pipeline Resilience

This feature aimed to make digests straightforward to configure and implement for our customers without requiring code changes when moving from a frequent transactional message to an aggregated message based on a schedule.

Digesting a Send API

Use automated failover to provide resiliency against potential issues that could prevent a notification from being delivered.

Automated Failover

As part of a Send in Courier, you can define the time to wait before delivering the message and Courier will handle. Courier supports one of three ways to delay

Delay

Courier Preferences gives your users the ability to control which notification topics they receive, through the channels of their choice. This feature is designed to give your users control over their communication preferences and to help you comply with data privacy regulations like GDPR and CCPA.

Preferences

Preferences Editor

Preference Center

User Preference Logs

Tenants are a flexible hierarchical database object meant for collecting groups of users and metadata belonging to the user group.

Tenants

Sending With Tenants

When you send a notification to the Courier Inbox with a tenant context, you send the notification to a separate inbox that is only accessible when the `tenantId` is configured.

Inbox and Tenants

User Preferences in Courier can be further refined by using Tenants. For example, if a user belongs to two tenants, the user can choose to opt out of one tenant's topic and opt in to the other.

User Tenant Preferences

Automations is a powerful notifications orchestration service. It allows anyone to easily design smart notification delivery workflows, without having to code anything.

Automations v3

The automations designer is a node-flow based visual programming environment designed for all technical skill levels.

Designer

The Automations Designer

All fields within the designer or an adhoc automation can be pointed to dynamic data using a special `refs` object syntax.

Dynamic Data

Accessing Dynamic Data

Automations Designer supports a variety of methods to trigger an automation. Courier ingests inbound events such as tracking or user identify, and persists them such that they can later get used as a trigger.

Inbound Event Triggers

One of the most common use cases for automations is hooking up notifications to segment events.

Segment

Often times you may want to cancel an automation run. For example, one automation may send out a reminder notification to complete a task. However, this reminder may no longer be necessary if the task is already completed. 

Cancelling

Cancelling An Automation

Automations can conditionally execute a branch of the workflow. This can be useful in any case where you may want to change the actions of an automation based on certain data sent with the template.

Control Flow

Conditional Control Flow

Scheduling is a feature of Automations that enables scheduling of a notification automation via three methods

Scheduling

Courier Automations can be leveraged to create recurring user digests on configured intervals. This can be useful for things like weekly reports or user digests, while also offering user schedule preferences if desired.

Digests

Courier's business tier customers have access to Webhook Triggers in Automations. Webhook Triggers enable you to connect other products and systems to Courier and trigger Automations based on events that happen in those systems. You have the full context of the webhook event payload and can use this data within the automation to send notifications, update profiles, or run workflows using Automation steps. This guide will walk you through how to register an inbound webhook and set up a Webhook Trigger.

Webhook Trigger

Batching is an Automations feature that aggregates events and consolidates multiple notifications into a single update.

Batching

The Throttle feature in Automations restricts the number of events that can trigger notification automations.

Throttle Node

Ad hoc automations can be defined and invoked in a single API call, without needing to create a full automation template. This document outlines the various types of steps you can use in an ad hoc automation run.

Ad hoc Automation Steps

The GET Profile node will attach the profile of the provided user id to the automation context. This allows you to use the profile data in subsequent nodes.

GET Profile

Courier Inbox is a set of APIs and SDKs that make it easy to add a modern notification inbox to your web or mobile application.

Inbox Push Notifications

In order to send notifications to Inbox, you need to [log-in](https://app.courier.com/login) to your Courier account and install the [Courier Provider](https://app.courier.com/channels/courier). Once you've done that, make note of the Client Key. You'll need that value to initialize the Inbox SDK.

Installing the Provider

Installing the Inbox Provider

When you're ready to [send a message](/docs/reference/send/message), it's exactly like sending any other Courier notification, with the difference being that you are sending it to the `inbox` channel.

Making an Inbox Send

Sending a Courier Inbox Message

Instead of defining the content of the entire notification in-line, you can leverage Templates to send a message.

Using a Template

Using a Notification Template

Courier Inbox supports the retrieval and display of different messages, filtered by parameters.

Inbox Views

When you create your Courier account, you are provisioned a Workspace.

Workspaces

Role-based Access Control (RBAC) is available to Courier customers on the Business Tier only.

Roles and Permissions

You can invite teammates to your workspace, require them to login via Google SSO, and choose to make your workspace discoverable to teammates who sign up on their own using your verified email domain.

Workspace Security Settings

When you have a long list of notifications, adding tags allows you to search and filter your list of Notifications by multiple, custom parameters in addition to Name and Channel.

Organizing and Filtering Notifications with Tags

Tracking Email Opens and Clicks

Removing the Courier Watermark

This guide will walk you through the steps necessary to allow your team to sign in to Courier with Okta.

Okta Integration

Learn how to use Courier's outbound webhooks for browser, email, mobile push, and other product notifications.

Outbound Webhooks

Courier provides numerous tools to help developers debug and analyze their applications.

Logging

Message Logs

The Courier Messages API allows you to fetch the array of events of a message you've previously sent, including the rendered content by using the endpoint.

Get Rendered Notification Content

See stats for notifications (sent, delivered, opened, clicked, errors, etc.) with the ability to filter per channel with customized time windows and date ranges.

Analytics

Audit Trail allows you to track a wide range of user activity for all members in a workspace.

Audit Trail

Custom Domain Tracking

The Courier CLI is a developer tool to help you build, test, and manage your integration with Courier directly from the command line.

Courier CLI

You can access our REST API and integrate Courier into your application using one of our [server SDK](./server-sdks) libraries.

Server SDKs

Client SDKs

The Courier React SDK provides access to a set of UI components and hooks that make building rich web applications with Courier easy. 

React.js SDK

Courier's library of integrations enables developers to quickly connect their preferred email, SMS, push notification, and chat providers, empowering product teams to efficiently manage multi-channel messaging from a unified platform.

Courier integrates with many different email providers, as well as SMTP. In order for a recipient to receive an email notification, their user profile must include an email address in the `email` property

Email Providers

Looking for a way to send email notifications via Amply? This step-by-step tutorial will show you how to integrate Amply's API the easy way.

Amply

AWS SES

Looking for a way to send emails and notifications via Gmail? This step-by-step tutorial will show you how to integrate Gmail's API the easy way.

Gmail

Looking for a way to send email notifications via MailerSend? This step-by-step tutorial will show you how to integrate MailerSend's API the easy way.

MailerSend

Looking for a way to send email notifications via Mailgun? This step-by-step tutorial will show you how to integrate Mailgun's API the easy way.

Mailgun

Looking for a way to send email notifications via Mailjet? This step-by-step tutorial will show you how to integrate Mailjet's API the easy way.

Mailjet

Looking for a way to send email notifications via Mandrill? This step-by-step tutorial will show you how to integrate Mandrill's API the easy way.

Mandrill

Looking for a way to send email notifications via OneSignal Email? This step-by-step tutorial will show you how to integrate OneSignal Email's API the easy way.

OneSignal Email

Looking for a way to send email notifications via Postmark? This step-by-step tutorial will show you how to integrate Postmark's API the easy way.

Postmark

Looking for a way to send email notifications via Resend? This step-by-step tutorial will show you how to integrate Resend's API the easy way.

Resend

SendGrid

Looking for a way to send email notifications via SMTP? This step-by-step tutorial will show you how to integrate SMTP's API the easy way.

SMTP

Looking for a way to send email notifications via SparkPost? This step-by-step tutorial will show you how to integrate SparkPost's API the easy way.

SparkPost

Courier supports a number of SMS Providers. In order to send a notification using an SMS Channel, the recipient profile must include an SMS capable phone number in the `phone_number` property.

SMS Providers

Looking for a way to send text message notifications via Africa's Talking? This step-by-step tutorial will show you how to integrate Africa's Talking's API the easy way.

Getting Started

Send

Audiences

Audit Events

AuthTokens

Automations

Brands

Bulk

Inbound

Lists

Messages

Notifications

Profiles

Tenants

Translations

User Preferences

User Tenants

User Tokens

Get Users in Tenant

Authorizations

Path Parameters

Query Parameters

Response