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 a push notification to a recipient over Airship, Courier must be provided the recipient's Airship user id and devices. These values should be included in the recipient profile as airship.

{
  "event": "{{event.id}}",
  "recipient": "{{recipient.id}}",
  "profile": {
    "airship": {
      "audience": {
        "named_user": "{{recipient.user_id}}"
      },
      "device_types": [
        "ios"
      ]
    }
  },
  "data": {
    "username": "Steph Courier"
  }
}

Override

You can use a provider override to replace what we send to Airship's API. For example, you can use basic auth with your send request:

{
  "event": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  "recipient": "abc123",
  "profile": {
    "airship": {
      "audience": {
        "named_user": "{{recipient.user_id}}"
      },
      "device_types": [
        "ios"
      ]
    }
  },
  "data": {
    "dataForPushMessage": true
  },
  "override": {
    "airship": {
      "body": {
        
      },
      "headers": {
        "Authorization": "Basic {{EncodedAppKey:AppSecret}}"
      }
    }
  }
}

Everything inside of override.airship will replace what we send to Airship's API. You can see all the available options by visiting Airship's website.

Updated about a year ago


Airship


Suggested Edits are limited on API Reference Pages

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