From 949c8e0af6ecd39ab4c5e1eb2ff08a9c2bbbbf4b Mon Sep 17 00:00:00 2001 From: Josiah South Date: Thu, 6 Jun 2024 14:15:53 -0400 Subject: [PATCH 1/5] Add Sendgrid Marketing Campaigns Source docs --- .../sendgrid-marketing-campaigns/index.md | 73 +++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md diff --git a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md new file mode 100644 index 0000000000..7e2b7ddad2 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md @@ -0,0 +1,73 @@ +--- +title: [SendGrid Marketing Campaigns] Source +--- + +[SendGrid Marketing Campaigns](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to automatically stream your email events directly into Segment to be used inside your warehouse or other downstream destinations. + +This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. + +This source is maintained by SendGrid Marketing Campaigns. For any issues with the source, [contact their Support team](mailto:support@sendgrid.com). + +## Getting started +1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. +2. Search for "SendGrid Marketing Campaigns" in the Sources Catalog, select SendGrid Marketing Campaigns, and click **Add Source**. +3. On the next screen, give the Source a name configure any other settings. + - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). +4. Click **Add Source** to save your settings. +5. Copy the Write key from the Segment UI. +6. Log in to your SendGrid Marketing Campaigns account - navigate to Integrations > Segment -> Connect and paste the key, select the matching region and any email events you want to receive. + +## Stream + +SendGrid Marketing Campaigns uses our stream Source component to send Segment event data. It uses a server-side `track` method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. + +SendGrid Marketing Campaigns passes a sha256 hash of the recipient's email address as `anonymousId`, the raw email address is passed in `context.traits.email`. + +## Events + +The table below lists events that SendGrid Marketing Campaigns sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. + +| Event Name | Description | +|-------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Email Processed | Email was sent successfully | +| Email Delivered | Email delivered successfully | +| Email Opened | Recipient opened the email | +| Email Machine Opened | Email was [opened anonymously](https://www.twilio.com/docs/sendgrid/for-developers/tracking-events/understanding-apple-mail-privacy-protection-and-open-events) | +| Email Link Clicked | Recipient clicked the [tracking link](https://www.twilio.com/docs/sendgrid/ui/account-and-settings/tracking#click-tracking) | +| Email Dropped | Email was [dropped by Sendgrid](https://www.twilio.com/docs/sendgrid/glossary/drops) | +| Email Bounced | Email servers [rejected the email](https://www.twilio.com/docs/sendgrid/ui/sending-email/bounces) | +| Unsubscribed | Recipient [unsubscribed globally](https://www.twilio.com/docs/sendgrid/ui/sending-email/global-unsubscribes) | +| Unsubscribed From Group | Recipient [unsubscribed from a group](https://www.twilio.com/docs/sendgrid/ui/sending-email/group-unsubscribes) | +| Resubscribed To Group | Recipient clicked the [group unsubscribe](https://www.twilio.com/docs/sendgrid/ui/sending-email/group-unsubscribes) | +| Email Marked as Spam | Recipient [reported the email as spam](https://www.twilio.com/docs/sendgrid/ui/analytics-and-reporting/spam-reports) | + +## Event Properties +The table below list the properties included in the events listed above. Some properties are only available for Single Sends or Automations. + +| Property Name | Description | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| `event` | Email event type | +| `anonymousId` | sha256 hash of the recipient email | +| `email_type` | "Singlesend" or "Automation" | +| `template_id` | Email template ID | +| `email_subject` | Subject line of the email, when available | +| `test_phase` | `true` if the Single Send is an [A/B Test](https://www.twilio.com/docs/sendgrid/ui/sending-email/a-b-testing) in the test phase | +| `unsubscribe_group_id` | ID of the unsubscribe group, when available | +| `link_url` | URL of the link clicked | +| `categories` | [Categories](https://www.twilio.com/docs/sendgrid/for-developers/sending-email/categories) associated to the email | +| `campaign_name` | Name of the Single Send | +| `campaign_id` | ID of the Single Send | +| `automation_name` | Name of the Automation | +| `automation_id` | ID of the Automation | +| `automation_step_id` | ID of the Automation step | +| `context.traits.email` | The recipient's raw (unhashed) email address | +| `context.traits.ip` | The opening computer's public IP address | +| `context.traits.user_agent` | The opening browser's user agent | + +## Adding Destinations + +Now that your Source is set up, you can connect it with Destinations. + +Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. + +If there are any issues with how the events are arriving to Segment, [contact the SendGrid Marketing Campaigns support team](mailto:support@sendgrid.com). From 83949685eb253eeb7124a4a14704eff57e3c5d0d Mon Sep 17 00:00:00 2001 From: Josiah South Date: Thu, 6 Jun 2024 14:25:47 -0400 Subject: [PATCH 2/5] Fix Resubscribed event description --- .../catalog/cloud-apps/sendgrid-marketing-campaigns/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md index 7e2b7ddad2..745351df1a 100644 --- a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md +++ b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md @@ -38,7 +38,7 @@ The table below lists events that SendGrid Marketing Campaigns sends to Segment. | Email Bounced | Email servers [rejected the email](https://www.twilio.com/docs/sendgrid/ui/sending-email/bounces) | | Unsubscribed | Recipient [unsubscribed globally](https://www.twilio.com/docs/sendgrid/ui/sending-email/global-unsubscribes) | | Unsubscribed From Group | Recipient [unsubscribed from a group](https://www.twilio.com/docs/sendgrid/ui/sending-email/group-unsubscribes) | -| Resubscribed To Group | Recipient clicked the [group unsubscribe](https://www.twilio.com/docs/sendgrid/ui/sending-email/group-unsubscribes) | +| Resubscribed To Group | Recipient resubscribed to a group | | Email Marked as Spam | Recipient [reported the email as spam](https://www.twilio.com/docs/sendgrid/ui/analytics-and-reporting/spam-reports) | ## Event Properties From 972f26d9219728d4a1a9c25093a8527d69f07ec2 Mon Sep 17 00:00:00 2001 From: Josiah Date: Fri, 14 Jun 2024 11:09:24 -0400 Subject: [PATCH 3/5] Target blank for all external links, frontmatter fields Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> --- .../sendgrid-marketing-campaigns/index.md | 24 ++++++++++--------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md index 745351df1a..1a0755a59b 100644 --- a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md +++ b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md @@ -1,5 +1,7 @@ --- -title: [SendGrid Marketing Campaigns] Source +title: SendGrid Marketing Campaigns Source +id: GCeG0vmcDW +beta: true --- [SendGrid Marketing Campaigns](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to automatically stream your email events directly into Segment to be used inside your warehouse or other downstream destinations. @@ -12,7 +14,7 @@ This source is maintained by SendGrid Marketing Campaigns. For any issues with t 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. 2. Search for "SendGrid Marketing Campaigns" in the Sources Catalog, select SendGrid Marketing Campaigns, and click **Add Source**. 3. On the next screen, give the Source a name configure any other settings. - - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). + - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. Sendgrid_Prod, Sendgrid_Staging, Sendgrid_Dev). 4. Click **Add Source** to save your settings. 5. Copy the Write key from the Segment UI. 6. Log in to your SendGrid Marketing Campaigns account - navigate to Integrations > Segment -> Connect and paste the key, select the matching region and any email events you want to receive. @@ -32,14 +34,14 @@ The table below lists events that SendGrid Marketing Campaigns sends to Segment. | Email Processed | Email was sent successfully | | Email Delivered | Email delivered successfully | | Email Opened | Recipient opened the email | -| Email Machine Opened | Email was [opened anonymously](https://www.twilio.com/docs/sendgrid/for-developers/tracking-events/understanding-apple-mail-privacy-protection-and-open-events) | -| Email Link Clicked | Recipient clicked the [tracking link](https://www.twilio.com/docs/sendgrid/ui/account-and-settings/tracking#click-tracking) | -| Email Dropped | Email was [dropped by Sendgrid](https://www.twilio.com/docs/sendgrid/glossary/drops) | -| Email Bounced | Email servers [rejected the email](https://www.twilio.com/docs/sendgrid/ui/sending-email/bounces) | -| Unsubscribed | Recipient [unsubscribed globally](https://www.twilio.com/docs/sendgrid/ui/sending-email/global-unsubscribes) | -| Unsubscribed From Group | Recipient [unsubscribed from a group](https://www.twilio.com/docs/sendgrid/ui/sending-email/group-unsubscribes) | +| Email Machine Opened | Email was [opened anonymously](https://www.twilio.com/docs/sendgrid/for-developers/tracking-events/understanding-apple-mail-privacy-protection-and-open-events){:target="_blank”} | +| Email Link Clicked | Recipient clicked the [tracking link](https://www.twilio.com/docs/sendgrid/ui/account-and-settings/tracking#click-tracking){:target="_blank”} | +| Email Dropped | Email was [dropped by Sendgrid](https://www.twilio.com/docs/sendgrid/glossary/drops){:target="_blank”} | +| Email Bounced | Email servers [rejected the email](https://www.twilio.com/docs/sendgrid/ui/sending-email/bounces){:target="_blank”} | +| Unsubscribed | Recipient [unsubscribed globally](https://www.twilio.com/docs/sendgrid/ui/sending-email/global-unsubscribes){:target="_blank”} | +| Unsubscribed From Group | Recipient [unsubscribed from a group](https://www.twilio.com/docs/sendgrid/ui/sending-email/group-unsubscribes){:target="_blank”} | | Resubscribed To Group | Recipient resubscribed to a group | -| Email Marked as Spam | Recipient [reported the email as spam](https://www.twilio.com/docs/sendgrid/ui/analytics-and-reporting/spam-reports) | +| Email Marked as Spam | Recipient [reported the email as spam](https://www.twilio.com/docs/sendgrid/ui/analytics-and-reporting/spam-reports){:target="_blank”} | ## Event Properties The table below list the properties included in the events listed above. Some properties are only available for Single Sends or Automations. @@ -51,10 +53,10 @@ The table below list the properties included in the events listed above. Some pr | `email_type` | "Singlesend" or "Automation" | | `template_id` | Email template ID | | `email_subject` | Subject line of the email, when available | -| `test_phase` | `true` if the Single Send is an [A/B Test](https://www.twilio.com/docs/sendgrid/ui/sending-email/a-b-testing) in the test phase | +| `test_phase` | `true` if the Single Send is an [A/B Test](https://www.twilio.com/docs/sendgrid/ui/sending-email/a-b-testing){:target="_blank”} in the test phase | | `unsubscribe_group_id` | ID of the unsubscribe group, when available | | `link_url` | URL of the link clicked | -| `categories` | [Categories](https://www.twilio.com/docs/sendgrid/for-developers/sending-email/categories) associated to the email | +| `categories` | [Categories](https://www.twilio.com/docs/sendgrid/for-developers/sending-email/categories){:target="_blank”} associated to the email | | `campaign_name` | Name of the Single Send | | `campaign_id` | ID of the Single Send | | `automation_name` | Name of the Automation | From 57ee0342665b832df3c92abd953ba4e9746e6588 Mon Sep 17 00:00:00 2001 From: Josiah Date: Fri, 14 Jun 2024 11:10:35 -0400 Subject: [PATCH 4/5] Update link to Sendgrid docs --- .../catalog/cloud-apps/sendgrid-marketing-campaigns/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md index 1a0755a59b..665a1ea1d9 100644 --- a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md +++ b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md @@ -4,7 +4,7 @@ id: GCeG0vmcDW beta: true --- -[SendGrid Marketing Campaigns](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to automatically stream your email events directly into Segment to be used inside your warehouse or other downstream destinations. +[SendGrid Marketing Campaigns](http://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to automatically stream your email events directly into Segment to be used inside your warehouse or other downstream destinations. This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. From ad562161855fbd1c35d4fd5c3a3a3eaf557bd69c Mon Sep 17 00:00:00 2001 From: pwseg <86626706+pwseg@users.noreply.github.com> Date: Fri, 14 Jun 2024 10:33:39 -0500 Subject: [PATCH 5/5] Minor cleanup --- .../sendgrid-marketing-campaigns/index.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md index 665a1ea1d9..679e982483 100644 --- a/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md +++ b/src/connections/sources/catalog/cloud-apps/sendgrid-marketing-campaigns/index.md @@ -4,30 +4,30 @@ id: GCeG0vmcDW beta: true --- -[SendGrid Marketing Campaigns](http://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} enables you to automatically stream your email events directly into Segment to be used inside your warehouse or other downstream destinations. +[SendGrid Marketing Campaigns](http://twilio.com/docs/sendgrid/ui/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} lets you automatically stream your email events directly into Segment for use inside your warehouse or other downstream destinations. -This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. +This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) that can not only export data into your Segment warehouse but also federate the exported data into your other enabled Segment destinations. This source is maintained by SendGrid Marketing Campaigns. For any issues with the source, [contact their Support team](mailto:support@sendgrid.com). ## Getting started 1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. 2. Search for "SendGrid Marketing Campaigns" in the Sources Catalog, select SendGrid Marketing Campaigns, and click **Add Source**. -3. On the next screen, give the Source a name configure any other settings. - - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. Sendgrid_Prod, Sendgrid_Staging, Sendgrid_Dev). +3. On the next screen, give the source a name configure any other settings. + - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but Segment recommends using something that reflects the source itself and distinguishes amongst your environments (for example, `Sendgrid_Prod`, `Sendgrid_Staging`, `Sendgrid_Dev`). 4. Click **Add Source** to save your settings. 5. Copy the Write key from the Segment UI. -6. Log in to your SendGrid Marketing Campaigns account - navigate to Integrations > Segment -> Connect and paste the key, select the matching region and any email events you want to receive. +6. Log in to your SendGrid Marketing Campaigns account - navigate to **Integrations > Segment -> Connect** and paste the key. Select the matching region and any email events you want to receive. ## Stream -SendGrid Marketing Campaigns uses our stream Source component to send Segment event data. It uses a server-side `track` method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. +SendGrid Marketing Campaigns uses Segment's stream Source component to send Segment event data. It uses a server-side Track method to send data to Segment. These events are then available in any destination that accepts server-side events and available in a schema in your data warehouse so you can query using SQL. -SendGrid Marketing Campaigns passes a sha256 hash of the recipient's email address as `anonymousId`, the raw email address is passed in `context.traits.email`. +SendGrid Marketing Campaigns passes a SHA256 hash of the recipient's email address as `anonymousId`. The raw email address is passed in `context.traits.email`. ## Events -The table below lists events that SendGrid Marketing Campaigns sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. +The following table lists events that SendGrid Marketing Campaigns sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. | Event Name | Description | |-------------------------|-----------------------------------------------------------------------------------------------------------------------------| @@ -49,7 +49,7 @@ The table below list the properties included in the events listed above. Some pr | Property Name | Description | |-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| | `event` | Email event type | -| `anonymousId` | sha256 hash of the recipient email | +| `anonymousId` | SHA256 hash of the recipient email | | `email_type` | "Singlesend" or "Automation" | | `template_id` | Email template ID | | `email_subject` | Subject line of the email, when available | @@ -68,8 +68,8 @@ The table below list the properties included in the events listed above. Some pr ## Adding Destinations -Now that your Source is set up, you can connect it with Destinations. +Now that your source is set up, you can connect it with destinations. -Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. +Log into your downstream tools and check to see that your events appear as expected and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool and refer to the Destination docs for each tool for troubleshooting. If there are any issues with how the events are arriving to Segment, [contact the SendGrid Marketing Campaigns support team](mailto:support@sendgrid.com).