Skip to main content

Setup

You will need a Mailjet account. In Mailjet, navigate to API Key Management to get your Public Key and Private Key. In Courier, navigate to the Mailjet Integration page, enter both keys and your From Address, then click “Save.”

Profile Requirements

To deliver a message to a recipient over Mailjet, Courier must be provided the recipient’s email address. This value should be included in the recipient profile as email.
{
  "message": {
    // Recipient Profile
    "to": {
      "email": "alice@acme.com"
    }

    // ... rest of message definition
  }
}

Overrides

You can use a provider override to replace what we send to Mailjet’s Send API. For example, you can add an attachment to your request:
{
  "message": {
    "template": "NOTIFICATION_TEMPLATE_ID",
    "to": {
      "email": "alice@acme.com"
    },
    "providers": {
      "mailjet": {
        "override": {
          "body": {
            "Attachments": [
              {
                "ContentType": "text/plain",
                "Filename": "test.txt",
                "content": "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK"
              }
            ]
          }
        }
      }
    }
  }
}
Everything inside of message.providers.mailjet.override will replace what we send to Mailjet’s Send API. You can see all the available options by visiting Mailjet API docs.