Courier

The Courier Developer Hub

Welcome to the Courier developer hub. You'll find comprehensive guides and documentation to help you start working with Courier as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

MagicBell

Profile Requirements

To deliver a message to in-app using MagicBell, Courier must be provided with either the email address of the recipient or an external ID.

Email example:

// Recipient Profile
{
  "email": "[email protected]"
}

External ID:

// Recipient Profile
{
  "magicbell": {
    "external_id": "user123"
  }
}

Override

Overrides can be used to change the request body that Courier uses to send a message to MagicBell. Overrides are useful when a field is not yet supported by Courier or you would like to override the value that Courier generates.

Below is an example of overriding the Category & Action URL parameters in MagicBell:

{
  "event": "example_template",
  "recipient": "example_user",
  "profile": {
    "email": "[email protected]"
  },
  "data": {},
  "override": {
    "magicbell": {
      "body": {
        "category": "new_message",
        "action_url": "https://example.com/example_link"
      }
    }
  }
}

Updated 3 months ago


MagicBell


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.