Skip to content

Commit e0f7f08

Browse files
pwsegpwseg
committed
Update Engage Events Source Docs [netlify-build] DOC-710 
1 parent 27b146c commit e0f7f08

File tree

3 files changed

+107
-28
lines changed

3 files changed

+107
-28
lines changed

‎src/_data/sidenav/main.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,8 +348,6 @@ sections:
348348
title: Set User Subscriptions
349349
- path: /engage/user-subscriptions/subscription-states
350350
title: Subscription States
351-
- path: /engage/user-subscriptions/engage-source
352-
title: Engage Events Source
353351
- path: /engage/user-subscriptions/subscription-sql
354352
title: Subscriptions with SQL Traits
355353
- section_title: Profiles

‎src/connections/sources/catalog/cloud-apps/engage-events/index.md

Lines changed: 107 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,109 @@
11
---
22
title: 'Engage Events Source'
3-
hidden: true
4-
---
3+
id: RPrXXW7nws
4+
redirect_from:
5+
- '/engage/user-subscriptions/engage-source'
6+
---
7+
8+
> info "Engage Premier"
9+
> The Engage Events Source is only available for use with [Engage Premier](/docs/engage/#market-to-customers-with-engage-premier-and-channels).
10+
11+
Use the Engage Events Source to sync Engage subscription states and messaging events to downstream Destinations.
12+
13+
## Update downstream subscription states
14+
15+
With Twilio Engage, you can [set and update user subscription states](/docs/engage/user-subscriptions/set-user-subscriptions/) with a [CSV file upload](/docs/engage/profiles/csv-upload/) or, programmatically, [using Segment APIs](/docs/engage/user-subscriptions/set-user-subscriptions/#manage-user-subscriptions-with-segment-apis).
16+
17+
As part of Engage, Segment creates an Engage Events Source that lets you sync subscription states and marketing analytics events [to connected Destinations](/docs/connections/destinations/). When a subscription state changes, Segment sends an update to the Destination. As a result, the subscription states stored in your Destination(s) can serve as a single source of truth for managing user consent in other tools that you may have connected to the Destination.
18+
19+
## Working with Engage Events Sources
20+
21+
Segment generates Engage Sources automatically. To find your Engage Events Sources in your workspace, navigate to **Connections > Sources** and select **Engage Events**.
22+
23+
If you have Engage messaging services set up, you can also find Engage sources in two ways:
24+
25+
- Navigate to **Engage > Audiences** and click **Add a destination** from the Audiences overview page.
26+
- Navigate to **Engage > Channels Settings** and add your Engage source from the **Engage Events source** section.
27+
28+
Segment sets a `Generated` status to Engage Sources in the **Statuses** column of the **My Sources** table.
29+
30+
From the **My Sources** table, you can select the Engage Source to add a Destination and configure the Source's settings. If you have more than one Engage space, Segment creates a separate Source for each space.
31+
32+
## Tracked events
33+
34+
The tables in this section list the events that the Engage Events Source tracks.
35+
36+
{% faq %}
37+
{% faqitem SMS events %}
38+
39+
| Event | Definition |
40+
| --------------- | --------------------------------------------------------------------------- |
41+
| SMS Processed | An SMS was processed. |
42+
| SMS Queued | An SMS has been queued for delivery. |
43+
| SMS Sending | An SMS is being sent. |
44+
| SMS Sent | An SMS was successfully sent, but delivery information isn't yet available. |
45+
| SMS Failed | The SMS couldn't be sent. |
46+
| SMS Delivered | The carrier confirmed that SMS delivery was successful. |
47+
| SMS Undelivered | The carrier confirmed that SMS delivery was unsuccessful. |
48+
| SMS Receiving | Engage is receiving an incoming message. |
49+
| SMS Received | Engage received an incoming message. |
50+
| SMS Read | An SMS was read. |
51+
52+
<br>
53+
54+
Twilio powers Engage SMS delivery. For more information, view [Twilio's documentation on SMS message statuses](https://support.twilio.com/hc/en-us/articles/223134347-What-are-the-Possible-SMS-and-MMS-Message-Statuses-and-What-do-They-Mean-){:target="_blank"}.
55+
56+
57+
{% endfaqitem %}
58+
59+
{% faqitem Email events %}
60+
61+
| Event | Definition |
62+
| ------------------------ | ------------------------------------------------------------------------------------- |
63+
| Email Processed | An email was processed and is ready to be delivered. |
64+
| Email Deferred | The receiving server temporarily rejected the email. |
65+
| Email Delivered | An email was successfully delivered to the receiving server. |
66+
| Email Opened | The recipient opened the email. |
67+
| Email Link Clicked | The recipient clicked a link within the email. |
68+
| Email Bounced | The receiving server permanently rejected the email. |
69+
| Email Dropped | The email was dropped before delivery. |
70+
| Email Marked as Spam | The recipient marked the email as spam. |
71+
| Email Machine Opened | The email was [machined opened](/docs/engage/analytics/#understanding-machine-opens). |
72+
| Email Unsubscribed | The recipient unsubscribed from all emails. |
73+
| Email Group Unsusbcribed | The recipient unsubscribed from a specific group. |
74+
| Email Subscribed | The recipient subscribed to all emails. |
75+
| Email Group Subscribed | The recipient subscribed to a specific group. |
76+
77+
<br>
78+
79+
SendGrid powers Engage email delivery. For more information, view [SendGrid's Event Webhook Documentation](https://docs.sendgrid.com/for-developers/tracking-events/event){:target="_blank"}.
80+
81+
82+
{% endfaqitem %}
83+
84+
{% faqitem WhatsApp events %}
85+
86+
| Event | Definition |
87+
| ---------------------------- | ----------------------------------------------------- |
88+
| WhatsApp Message Queued | The WhatsApp message creation requested was recieved. |
89+
| WhatsApp Message Accepted | The WhatsApp message creation request was accepted. |
90+
| WhatsApp Message Sending | The WhatsApp message is being sent. |
91+
| WhatsApp Message Sent | The WhatsApp message was successfully sent. |
92+
| WhatsApp Message Failed | The WhatsApp message couldn't be sent. |
93+
| WhatsApp Message Delivered | WhatsApp message delivery was successful. |
94+
| WhatsApp Message Undelivered | The WhatsApp message wasn't delivered. |
95+
| WhatsApp Message Receiving | Engage is receiving an incoming WhatsApp message. |
96+
| WhatsApp Message Received | Engage received an incoming WhatsApp message. |
97+
| WhatsApp Message Read | The recipient read the WhatsApp message. |
98+
99+
{% endfaqitem %}
100+
101+
{% faqitem Subscription events %}
102+
103+
| Event | Definition |
104+
| ---------------------------- | ------------------------------------------------------ |
105+
| Channel Subscription Updated | A user updated their channel subscription. |
106+
| Group Subscription Updated | A user updated their subscription to a specific group. |
107+
108+
{% endfaqitem %}
109+
{% endfaq %}

‎src/engage/user-subscriptions/engage-source.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)