SendGrid connection
Overview overview
SendGrid is a popular customer communication platform for transactional and marketing emails.
This Adobe Experience Platform destination leverages the SendGrid Marketing Contacts API, which allows you to export your first-party email profiles and activate them within a new SendGrid audience for your business needs.
SendGrid uses API bearer tokens as an authentication mechanism to communicate with the SendGrid API.
Prerequisites prerequisites
The following items are required before you start configuring the destination.
-
You need to have a SendGrid account.
- Go to the SendGrid signup page to register and create a SendGrid account, if you do not have one already.
-
After logging in to the SendGrid portal, you also need to generate an API token.
-
Navigate to the SendGrid website and access the Settings > API Keys page. Alternatively, refer to the SendGrid documentation to access the appropriate section in the SendGrid app.
-
Finally, select the Create API Key button.
- Refer to the SendGrid documentation, if you need guidance on what actions to perform.
- If you would like to programmatically generate your API Key, please refer to the SendGrid documentation.
Before activating data to the SendGrid destination, you must have a schema, a dataset, and segments created in Experience Platform. Refer also to the limits section further below on this page.
-
The SendGrid API used for creating the mailing list from email profiles requires unique email addresses to be provided within each profile. This is irrespective of whether it is used as a value for email or alternate email. Because the SendGrid connection supports mappings for both email and alternate email values, please ensure that all email addresses used should be unique within each profile of the Dataset. Otherwise, when the email profiles are sent to SendGrid, this will result in an error and that email profile will not be present in the data export.
-
Currently, there is no functionality in place to remove profiles from SendGrid when they are removed from audiences in Experience Platform.
Supported identities supported-identities
SendGrid supports the activation of identities described in the table below. Learn more about identities.
Note that SendGrid does not support hashed email addresses, so only plain text data without transformation is sent to the destination.
Export type and frequency export-type-frequency
Refer to the table below for information about the destination export type and frequency.
Use cases use-cases
To help you better understand how and when you should use the SendGrid destination, here are sample use cases that Experience Platform customers can solve by using this destination.
Create a marketing list for multiple marketing activities
Marketing teams using SendGrid can create a mailing list within SendGrid and populate it with email addresses. The mailing list now created within SendGrid can subsequently be used for multiple marketing activities.
Connect to destination connect
To connect to this destination, follow the steps described in the destination configuration tutorial. In the configure destination workflow, fill in the fields listed in the two sections below.
Authenticate to destination authenticate
-
Within the Adobe Experience Platform console, navigate to Destinations.
-
Select the Catalog tab and search for SendGrid. Then select Set up. After you have established a connection to the destination, the UI label changes to Activate Segments.
-
You are shown a wizard which assists you in configuring the SendGrid destination. Create the new destination by selecting Configure new destination.
-
Select the New Account option and fill in the Bearer Token value. This value is the SendGrid API Key previously mentioned in the prerequisites section.
-
Select Connect to destination. If the SendGrid API Key you provided is valid, the UI displays a Connected status with a green check mark, you can then proceed to the next step to fill in additional information fields.
Fill in destination details destination-details
While setting up this destination, you must provide the following information:
- Name: The name by which you will recognize this destination in the future.
- Description: An optional description that will help you identify this destination in the future.
Enable alerts enable-alerts
You can enable alerts to receive notifications on the status of the dataflow to your destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, see the guide on subscribing to destinations alerts using the UI.
When you are finished providing details for your destination connection, select Next.
Activate audiences to this destination activate
-
To activate data, you need the View Destinations, Activate Destinations, View Profiles, and View Segments access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.
-
To export identities, you need the View Identity Graph access control permission.
img-md w-100 modal-image
Read Activate profiles and audiences to streaming audience export destinations for instructions on activating audiences to this destination.
Refer to the below images for details specific to this destination.
-
Select one or more audiences to export to SendGrid.
-
In the Mapping step, after selecting Add new mapping, you are shown the mapping page to map the source XDM fields to the SendGrid API target fields. The images below demonstrate how to map identity namespaces between Experience Platform and SendGrid. Please ensure the Source field Email should be mapped to the Target field external_id as shown below.
-
Similarly, map the desired Adobe Experience Platform attributes that you want to export to the SendGrid destination.
-
After completing the mappings, select Next to advance to the review screen.
-
Select Finish to complete the setup.
The comprehensive list of supported attribute mappings that can be set up for the SendGrid Marketing Contacts > Add or Update Contact API is below.
homeAddress.street1
address_line_1
100 characters
homeAddress.street2
address_line_2
100 characters
_extconndev.alternate_emails
alternate_emails
- Max: 5 items
- Min: 0 items
homeAddress.city
city
60 characters
homeAddress.country
country
50 characters
external_id
254 characters
person.name.firstName
first_name
50 characters
person.name.lastName
last_name
50 characters
homeAddress.postalCode
postal_code
homeAddress.stateProvince
state_province_region
50 characters
Validate the data export within SendGrid validate
To validate that you have correctly set up the destination, follow the steps below:
-
Select Destinations > Browse to navigate to the list of destinations.
-
Select the destination and validate that the status is enabled.
-
Switch to the Activation data tab, then select an audience name.
-
Monitor the audience summary and check the count of profiles corresponds to the count created within the dataset.
-
The SendGrid Marketing Lists > Create List API is used to create unique contact lists within SendGrid by joining the value of the list_name attribute and the timestamp of the data export. Navigate to the SendGrid site and check if the new contact list conforming to the name pattern is created.
-
Select the newly created contact list and check if the new email record from the dataset you created is being populated within the new contact list.
-
Additionally, also check a couple of emails to validate if the field mapping is correct.
Data usage and governance data-usage-governance
All Adobe Experience Platform destinations are compliant with data usage policies when handling your data. For detailed information on how Adobe Experience Platform enforces data governance, see the Data Governance overview.
Additional resources additional-resources
This SendGrid destination leverages the below APIs:
Limits limits
- The SendGrid Marketing Contacts > Add or Update Contact API can accept 30,000 contacts, or 6MB of data, whichever is lower.