Skip to main content

​
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:

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

​
External ID:

{
  "message": {
    // Recipient Profile
    "to": {
      "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: 
{
  "message": {
    "template": "example_template",
    "to": {
      "email": "[email protected]"
    },
    "data": {},
    "providers": {
      "magicbell": {
        "override": {
          "body": {
            "category": "new_message",
            "action_url": "https://example.com/example_link"
          }
        }
      }
    }
  }
}