Antavo Source documentation #7275
Conversation
|
Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors |
|
|
Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors |
|
| ## Events | ||
|
|
||
| Two main event types are synced into Segment: Profile updates and loyalty events. | ||
| Both event types require userID, which can be selected in Antavo. | ||
| Any customer attribute in Antavo can be selected as "external customer ID". |
There was a problem hiding this comment.
| ## Events | |
| Two main event types are synced into Segment: Profile updates and loyalty events. | |
| Both event types require userID, which can be selected in Antavo. | |
| Any customer attribute in Antavo can be selected as "external customer ID". | |
| ## Events | |
| Antavo syncs two main types of events to Segment: Profile Updates and Loyalty Events. Profile Updates are sent as Segment Identify events, while Loyalty Events are sent as Segment Track events. | |
| Both event types include a `userId`, which can be configured in Antavo. You can designate any customer attribute as the "external customer ID" to use as the Segment `userId`. |
There was a problem hiding this comment.
hi @tcgilbert
thanks, this is now applied
| ### Profile updates | ||
|
|
||
| This event happens when a customer attribute - added to the **Customer field sync** - changes. | ||
| - Antavo always includes the `userId`. | ||
| - Customer attributes are included in `traits` object. |
There was a problem hiding this comment.
| ### Profile updates | |
| This event happens when a customer attribute - added to the **Customer field sync** - changes. | |
| - Antavo always includes the `userId`. | |
| - Customer attributes are included in `traits` object. | |
| ### Profile updates | |
| Profile Updates occur when a customer attribute, added to the Antavo **Customer field sync***, updates. Customer attributes are included in the traits object. |
There was a problem hiding this comment.
hi @tcgilbert
thanks for the suggestion, this is now applied
| ### Loyalty events | ||
|
|
||
| When a built-in or custom loyalty event - added to the **Event sync** - happens, event data are streamlined to the Antavo Source. | ||
| - Antavo always includes the `userId`. | ||
| - Event properties are included in `properties` object. |
There was a problem hiding this comment.
| ### Loyalty events | |
| When a built-in or custom loyalty event - added to the **Event sync** - happens, event data are streamlined to the Antavo Source. | |
| - Antavo always includes the `userId`. | |
| - Event properties are included in `properties` object. | |
| ### Loyalty events | |
| Loyalty Events occur when a built-in or custom event, added to the Antavo Event sync, is triggered. The event data is then sent to the Segment Antavo Source. Event properties are included in the properties object. |
There was a problem hiding this comment.
@bbantavo What are the different event names a customer can expect to be sent into Segment? Is there a standard list of events, or is this all configured in a custom way by the user? If there is a standardized list, we ask that partner provide a table of the expected events:
e.g.,
| Event Name | Description |
| ------------------ | ------------------------------------- |
| Email Sent | Email was sent successfully |
| Email Opened | Prospect opened the email |
| Link Clicked | Prospect clicked the tracking link |
| Email Replied | Prospect replied to email sent |
| Email Bounced | Email servers rejected the email |
| Email Unsubscribed | Prospect clicked the unsubscribe link |
There was a problem hiding this comment.
Hi @tcgilbert
Our Source integration requires our clients to configure which events they want to sync to Segment. By default no event is synced.
Our clients have a start set of built-in events which are fully customizable, and they also have the ability the define custom events.
We can provide information about our built-in events, but their meaning could differ from client to client.
Source documentation updates
| ``` | ||
| title: Antavo Source | ||
| ``` |
There was a problem hiding this comment.
| ``` | |
| title: Antavo Source | |
| ``` | |
| --- | |
| title: Antavo Source | |
| id: WXNgKpZMsd | |
| --- |
There was a problem hiding this comment.
hi @tcgilbert
this is now updated, please check
Updated Source document
| "timestamp": "2024-11-26T15:15:49.000Z", | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Integrations Object
Antavo automatically filters data from being sent to Salesforce destinations (Salesforce (Actions), Salesforce Marketing Cloud (Actions)) and the Antavo destination. This is achieved by adding these destinations to the Integrations object in the event payloads. Since Antavo has a dedicated Salesforce integration, this filtering helps prevent infinite loops.
There was a problem hiding this comment.
hi @tcgilbert !
thanks for the suggestion! we'll apply it shortly
quick note: the links seems to be pointing to github.com domain (throwing 404s), but I'm guessing it should be to segment.com instead
There was a problem hiding this comment.
Hi @tcgilbert !
Updated this section, please check!
updated index.md
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Proposed changes
Added Antavo Source documentation files.
Merge timing
asap
Related issues (optional)