-
Notifications
You must be signed in to change notification settings - Fork 393
[SendGrid Lists Destination] - doc for new SendGrid Lists Destination #7301
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 24 commits
ae1dab4
b6c3bac
1ff245d
2da3520
fcfd62c
96c4618
bdd0641
ab08b86
d5941a0
41414d8
9fdba03
f65116e
8e82870
4ca0fdc
4ae46ab
df91880
bc21536
a992ce7
d495129
0b40022
f2a8521
0e6ec7c
0690081
0395b87
86bd73a
996f6cd
151249f
b856a76
0536f9b
49901f1
9014559
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
title: SendGrid Lists (Actions) Destination | ||
engage: true | ||
id: | ||
--- | ||
|
||
{% include content/plan-grid.md name="actions" %} | ||
|
||
[SendGrid Lists (Actions)](https://mc.sendgrid.com/contacts/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} helps customers organize their email recipients into targeted groups, enabling them to send personalized, relevant content to specific audiences. This improves engagement, increases email deliverability, and streamlines campaign management. | ||
|
||
This destination is maintained by Segment. For any issues with the destination, [contact the Segment Support team](mailto:[email protected]). | ||
|
||
## Getting started | ||
|
||
SendGrid Lists (Actions) is designed to work with Engage Audiences only. The steps below outline how to create and connect the Destination to Engage and then to an Engage Audience. SendGrid Lists (Actions) is not designed to connect to Connections Sources. | ||
|
||
### Create a SendGrid API Key | ||
1. Sign in to your SendGrid account, then navigate to **Settings** > **API Keys**. | ||
2. Click **Create API Key** and follow the instructions to generate a new API key. Be sure to grant the API key **Full Access** permission. | ||
3. Save the API key value in a secure location, as you will need it in later steps. | ||
|
||
### Connect a SendGrid Lists (Actions) destination to an Engage Space | ||
|
||
1. From your Segment workspace's home page, navigate to **Engage** > **Engage Settings** > **Settings** and click **Add destination**. | ||
2. Search for SendGrid Lists (Actions) and select the SendGrid Lists (Action) tile. Click **Add Destination** and **Confirm Source**. | ||
3. On the Basic Settings screen, provide **Name** and **API Key** values in the specified fields, toggle "Enable destination" to on, and then click **Save Changes**. | ||
|
||
### Create a Mapping | ||
|
||
1. From your Segment workspace's home page, click **Connections** > **Destinations** and select the SendGrid Lists (Actions) destination you previously created. | ||
2. Click on **Mappings** > **New Mapping** > **Sync Audience** > **Save**. | ||
3. On the next screen, enable the Mapping using the **Status** toggle. | ||
|
||
### Connect an Audience | ||
|
||
1. From your Segment workspace's home page, navigate to **Engage** > **Audiences** and select the Audience you'd like to sync to SendGrid. | ||
2. Click **Add Destination**, and select the SendGrid Lists (Actions) destination you previously created. | ||
3. Enter a **List Name**, select **Default Setup**, and click **Save**. When prompted, select **Add 1 Destination**. | ||
|
||
The SendGrid Lists (Actions) destination will now start to sync your Engage Audience to a SendGrid List. | ||
|
||
{% include components/actions-fields.html %} | ||
|
||
|
||
## Additional information | ||
|
||
|
||
### Does Segment create Lists in SendGrid? | ||
Segment automatically creates Lists in SendGrid. If you provide a value in the **Name** field, Segment names the List the value you provided. If you do not provide a name in the **Name** field, Segment gives the List the Engage Audience's **Audience Key** value. | ||
|
||
### Does Segment create new Contacts in SendGrid? | ||
Segment creates Contacts in SendGrid if a Contact doesn't already exist for the user. | ||
|
||
### Does Segment delete Contacts from SendGrid? | ||
Segment doesn't delete Contacts from SendGrid. If you remove a user from an Engage Audience, Segment does remove the Contact from the associated SendGrid List, but doesn't delete the Contact from SendGrid. | ||
|
||
### Sending additional user traits | ||
joe-ayoub-segment marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Segment supports sending Engage user profile traits to SendGrid Contact User Attributes. The following additional manual configuration steps are required: | ||
|
||
1. Use [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) to include specific user profile traits when syncing users to a SendGrid List. | ||
2. Standard User Attributes: Use the [Sync Audience Action](#sync-audience-action)'s User Attributes field to map the following [Contact Profile Fields](https://www.twilio.com/docs/sendgrid/ui/managing-contacts/segmenting-your-contacts#contact-profile-fields){:target="_blank”} to SendGrid: | ||
- First Name | ||
- Last Name | ||
- Address Line 1 | ||
- Address Line 2 | ||
- City | ||
- State/Province/Region | ||
- Country | ||
- Postal Code | ||
3. Custom User Attributes: Define a custom User Attribute in SendGrid, then use [Sync Audience ](#sync-audience-action) Action to send custom User Attributes to SendGrid using the Custom Fields field. You can only send string, number, and date values to SendGrid with this method. | ||
|
||
### Supported identifiers | ||
Segment can sync members of an Engage Audience to a SendGrid List using any of the following identifier types: | ||
- Email Address | ||
- Anonymous ID | ||
- Phone Number ID | ||
- External ID | ||
|
||
To sync Engage users to a list using Anonymous ID, Phone Number ID, and External ID identifier types, complete the following configuration steps: | ||
|
||
1. Configure [ID Sync](/docs/engage/trait-activation/id-sync/) to include Anonymous ID, Phone Number ID, or External ID identifiers when syncing users from an Engage Audience to the SendGrid List. | ||
2. Map the Anonymous ID, Phone Number ID, and External ID identifiers using the [Sync Audience ](#sync-audience-action) Action's Anonymous ID, Phone Number ID, and External ID fields. |
Uh oh!
There was an error while loading. Please reload this page.