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

Profile Requirements

To deliver an in-app push message to a recipient over Intercom, Courier must be provided the recipient's Intercom's User ID. Courier assumes the User is of type user.

// Recipient Profile
{
  "intercom": {
    "from": "012345",
    "to": {
       "id": "<Intercom User ID>"
    }
  }
}

Override

You can use the provider override to replace what we send as an Intercom Message. Supported overrides include the message body and the From User ID. Here's an example where we override both:

{  
  "event": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  "profile": {
    "intercom": {
      "id": "<Intercom User ID>"
    }
  },
  "override": {
    "intercom": {
      "body": {
        "body": "I overrode this message",
        "from": {
          "id": "012345"
        }
      }
    }
  }
}

Other supported overrides are here.

Updated about a year ago


Intercom


Suggested Edits are limited on API Reference Pages

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