Antavo Destination documentation #7276
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
|
stayseesong
requested changes
Dec 3, 2024
Comment on lines
1
to
29
| ``` | ||
| title: Antavo Actions Destination | ||
| ``` | ||
|
|
||
| Antavo Actions Destination app allows you to sync profile updates in Segment and trigger loyalty events. | ||
|
|
||
| This destination app is maintained by Antavo. For any issues with the destination app, [contact the Antavo support team](mailto:[email protected]). | ||
|
|
||
| ## Getting started | ||
|
|
||
| 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "Antavo Actions". | ||
| 2. Select and click **Add Destination**. | ||
| 3. Select an existing Source to connect to Antavo Actions. | ||
| 4. Log in to Antavo and go to the **Settings → API Settings** menu; find and copy your Antavo **API key**. | ||
| 5. Paste the **API Key** in the destination settings in Segment. | ||
| 6. Go to mappings to set events you want to sync into Antavo | ||
| - Select the Profile event template to sync customer data changes into Antavo | ||
| - in this template, you need to map the customer ID first, which should match with the Antavo settings | ||
| - if the multi-account extension is enabled in Antavo, you need to make sure to include the account ID | ||
| - customer attributes be included in the Data section - make sure attribute names match your Antavo settings | ||
|
|
||
|  | ||
| - Select the Loyalty event template to trigger loyalty events. | ||
| - in this template, you need to map the customer ID first, which should match with the Antavo settings | ||
| - if the multi-account extension is enabled in Antavo, you need to make sure to include the account ID | ||
| - event attributes can be included in the Data section - make sure attribute names match your Antavo settings | ||
|
|
||
|  | ||
| 7. If you haven’t configured the Segment integration in Antavo, please go to the Modules menu and enable Twilio Segment Extension |
There was a problem hiding this comment.
Suggested change
| ``` | |
| title: Antavo Actions Destination | |
| ``` | |
| Antavo Actions Destination app allows you to sync profile updates in Segment and trigger loyalty events. | |
| This destination app is maintained by Antavo. For any issues with the destination app, [contact the Antavo support team](mailto:[email protected]). | |
| ## Getting started | |
| 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "Antavo Actions". | |
| 2. Select and click **Add Destination**. | |
| 3. Select an existing Source to connect to Antavo Actions. | |
| 4. Log in to Antavo and go to the **Settings → API Settings** menu; find and copy your Antavo **API key**. | |
| 5. Paste the **API Key** in the destination settings in Segment. | |
| 6. Go to mappings to set events you want to sync into Antavo | |
| - Select the Profile event template to sync customer data changes into Antavo | |
| - in this template, you need to map the customer ID first, which should match with the Antavo settings | |
| - if the multi-account extension is enabled in Antavo, you need to make sure to include the account ID | |
| - customer attributes be included in the Data section - make sure attribute names match your Antavo settings | |
|  | |
| - Select the Loyalty event template to trigger loyalty events. | |
| - in this template, you need to map the customer ID first, which should match with the Antavo settings | |
| - if the multi-account extension is enabled in Antavo, you need to make sure to include the account ID | |
| - event attributes can be included in the Data section - make sure attribute names match your Antavo settings | |
|  | |
| 7. If you haven’t configured the Segment integration in Antavo, please go to the Modules menu and enable Twilio Segment Extension | |
| --- | |
| title: Antavo (Actions) Destination | |
| --- | |
| The Antavo (Actions) Destination allows you to sync profile updates in Segment and trigger loyalty events. | |
| This destination is maintained by Antavo. For any issues with the destination, [contact the Antavo support team](mailto:[email protected]). | |
| ## Getting started | |
| 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for **Antavo (Actions)**. | |
| 2. Click **Add Destination**. | |
| 3. Select an existing Source to connect to Antavo (Actions). | |
| 4. Log in to Antavo and go to the **Settings > API Settings** and copy your Antavo **API key**. | |
| 5. Paste the **API Key** in the destination settings in Segment. | |
| 6. Configure your mappings to set events you want to sync to Antavo. You can choose from 2 actions: Send Loyalty Event and Send Profile Update. | |
| - If the multi-account extension is enabled in Antavo, make sure to include the account ID. | |
| - If customer attributes are included in the Data section - make sure attribute names match your Antavo settings. | |
| 7. If you haven’t configured the Segment integration in Antavo, go to the **Modules** menu and enable the Twilio Segment Extension in Antavo. |
There was a problem hiding this comment.
hi @stayseesong
thanks for the suggestions, we have applied them, please check them
Destination documentation updates
|
@bbantavo @stayseesong - we can merge this as hidden once my requested changes are in. The destination is still pending review, so there is no destination id for this yet |
|
@tcgilbert I don't see your requested changes |
tcgilbert
requested changes
Dec 16, 2024
Comment on lines
1
to
3
| --- | ||
| title: Antavo (Actions) Destination | ||
| --- |
There was a problem hiding this comment.
Suggested change
| --- | |
| title: Antavo (Actions) Destination | |
| --- | |
| --- | |
| title: Antavo (Actions) Destination | |
| hidden: true | |
| --- |
| 6. Configure your mappings to set events you want to sync to Antavo. You can choose from 2 actions: Send Loyalty Event and Send Profile Update. | ||
| - If the multi-account extension is enabled in Antavo, make sure to include the account ID. | ||
| - If customer attributes are included in the Data section - make sure attribute names match your Antavo settings. | ||
| 7. If you haven’t configured the Segment integration in Antavo, go to the **Modules** menu and enable the Twilio Segment Extension in Antavo. |
There was a problem hiding this comment.
Suggested change
| 7. If you haven’t configured the Segment integration in Antavo, go to the **Modules** menu and enable the Twilio Segment Extension in Antavo. | |
| 7. If you haven’t configured the Segment integration in Antavo, go to the **Modules** menu and enable the Twilio Segment Extension in Antavo. | |
| {% include components/actions-fields.html %} |
There was a problem hiding this comment.
hi @tcgilbert
we've applied the changes, please check
@stayseesong sorry was left in pending! added my review now @bbantavo |
updated index.md
tcgilbert
approved these changes
Dec 18, 2024
|
@tcgilbert is this good to merge in even though there's no destination ID? |
stayseesong
approved these changes
Dec 19, 2024
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Added Antavo Destination documentation files.
Merge timing
asap
Related issues (optional)