Loading...
Skip to main content

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": "user@example.com"
}

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": "user@example.com"
  },
  "data": {},
  "override": {
    "magicbell": {
      "body": {
        "category": "new_message",
        "action_url": "https://example.com/example_link"
      }
    }
  }
}