SendGrid Channel Provider

Configuration

The configuration steps are explained in the sendgrid configuration page.

Usage

1. When configured with

{
  "api_key": "SG.1234567890",
  "from": {
    "email": "company@example.com",
    "name": "Company Name"
  },
  "reply_to": {
    "email": "reply-to@example.com",
    "name": "Reply to Company"
  }
}

2. With a channel token

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "api_key": {
      "description": "The API key for Sendgrid",
      "type": "string"
    },
    "from": {
      "properties": {
        "email": {
          "description": "The email address to send from",
          "format": "email",
          "type": "string"
        },
        "name": {
          "description": "The name to send from",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "email"
      ],
      "type": "object"
    },
    "reply_to": {
      "properties": {
        "email": {
          "description": "The email address to reply to",
          "format": "email",
          "type": "string"
        },
        "name": {
          "description": "The name to reply to",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "email"
      ],
      "type": "object"
    }
  },
  "required": [
    "api_key"
  ],
  "type": "object"
}

3. With Broadcast

{
  "action_url": "https://example.com",
  "category": "example",
  "content": "I come from broadcast",
  "custom_attributes": {},
  "id": "d1b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
  "overrides": {},
  "recipients": [
    {
      "custom_attributes": {
        "plan": "enterprise",
        "preferred_pronoun": "They",
        "pricing_version": "v10"
      },
      "email": "test@example.com",
      "external_id": "83d987a-83fd034",
      "first_name": "Person",
      "last_name": "Doe",
      "phone_numbers": [
        "+1 5005550001"
      ]
    }
  ],
  "title": "Hello, World!",
  "topic": "example"
}

The channel handler triggers a HTTP request

POST https://api.sendgrid.com/v3/mail/send

With payload

{
  "content": [
    {
      "type": "text/html",
      "value": "I come from broadcast"
    }
  ],
  "from": {
    "email": "company@example.com",
    "name": "Company Name"
  },
  "personalizations": [
    {
      "to": [
        {
          "email": "dan@example.com",
          "name": null
        }
      ]
    }
  ],
  "reply_to": {
    "email": "reply-to@example.com",
    "name": "Reply to Company"
  },
  "subject": "Hello, World!"
}

Overrides

The provider overrides key in the broadcast payload can be used to change the default behavior of the channel handler.

overrides >> providers >> sendgrid

Override `from` key

Overrides

{
  "providers": {
    "sendgrid": {
      "from": {
        "email": "another@example.com"
      }
    }
  }
}

Payload

{
  "content": [
    {
      "type": "text/html",
      "value": "I come from broadcast"
    }
  ],
  "from": {
    "email": "another@example.com",
    "name": "Company Name"
  },
  "personalizations": [
    {
      "to": [
        {
          "email": "dan@example.com",
          "name": null
        }
      ]
    }
  ],
  "reply_to": {
    "email": "reply-to@example.com",
    "name": "Reply to Company"
  },
  "subject": "Hello, World!"
}

Override `custom_args` key

Overrides

{
  "providers": {
    "sendgrid": {
      "custom_args": {
        "tracking_id": "abcd1234"
      }
    }
  }
}

Payload

{
  "content": [
    {
      "type": "text/html",
      "value": "I come from broadcast"
    }
  ],
  "custom_args": {
    "tracking_id": "abcd1234"
  },
  "from": {
    "email": "company@example.com",
    "name": "Company Name"
  },
  "personalizations": [
    {
      "to": [
        {
          "email": "dan@example.com",
          "name": null
        }
      ]
    }
  ],
  "reply_to": {
    "email": "reply-to@example.com",
    "name": "Reply to Company"
  },
  "subject": "Hello, World!"
}