-
Notifications
You must be signed in to change notification settings - Fork 395
[Nudge] Documentation for new action destination #7676
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 4 commits
bf1a402
31b38f9
e410ad3
140ad2d
a39543d
12efce8
95285bf
ad39318
d269108
f5856f8
330678b
2e0635b
0c9250e
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,97 @@ | ||||||||||||||||
| --- | ||||||||||||||||
| title: Nudge (Actions) Destination | ||||||||||||||||
| id: | ||||||||||||||||
| --- | ||||||||||||||||
|
|
||||||||||||||||
| {% include content/plan-grid.md name="actions" %} | ||||||||||||||||
|
|
||||||||||||||||
| [Nudge](https://nudgenow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an AI personalization platform for marketing teams for enabling rapid personalization experimentation and for autonomously delivering 1:1 user experiences. | ||||||||||||||||
|
|
||||||||||||||||
| This destination is maintained by the Nudge Developer Team. For any issues with the destination, [contact the 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 "Nudge". | ||||||||||||||||
|
||||||||||||||||
| 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Nudge". | |
| 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for *Nudge*. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 5. Go to the **Secret Keys** section and click on the **Create new secret key** button. | |
| 5. Go to the **Secret Keys** section and click **Create new secret key**. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 6. Give appropriate name for the key, select the **Backend API** option from the permissions dropdown and create the key. | |
| 6. Give an appropriate name for the key, then select the **Backend API** option from the permissions dropdown and create the key. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 8. Enter the generated API key in the **Nudge** destination settings in Segment. | |
| 8. Paste the generated API key in the **Nudge** destination settings in Segment. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Nudge (Actions) Destination currently supports the Identify and Track methods listed below in accordance to the core Segment Specs. Reference: [Spec Overview](https://segment.com/docs/connections/spec/) | |
| The Nudge (Actions) Destination currently supports the Identify and Track methods listed below in accordance to the core Segment Specs. Reference: [Spec Overview](/docs/connections/spec/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would removing the domain from the URL still point to the Spec Overview documentation page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| **Example (using Segment's Analytics.js SDK)** | |
| Example (using Segment's Analytics.js SDK): |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * If `userId` does not exist, the request would throw a 400 validation error as it is a required field. | |
| * If `userId` doesn't exist, the request throws a 400 validation error as it's a required field. |
piyush-nudge marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| **Example (using Segment's Analytics.js SDK)** | |
| Example (using Segment's Analytics.js SDK): |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### 1. Events not showing up in Nudge | |
| ### Events aren't showing up in Nudge |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * **Missing or invalid API key** | |
| Ensure that the API key you generated under **Settings → Secret Keys → Backend API** is correctly entered in your Segment destination settings. | |
| * **Dropped Identify/Track calls** | |
| Calls without `userId`, or with only `anonymousId`, are automatically dropped. Verify your mapping includes the correct identifier field. | |
| Events may not show up in Nudge due to: | |
| * **Missing or invalid API key.** Ensure that the API key you generated under **Settings > Secret Keys > Backend API** is correctly entered in your Segment destination settings. | |
| * **Dropped Identify/Track calls.** Calls without `userId`, or with only `anonymousId`, are automatically dropped. Verify your mapping includes the correct identifier field. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### 2. Timestamp or date format errors | |
| ### Timestamp or date format errors |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### 3. Validation failures | |
| ### Validation failures |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * Compare against Nudge’s specification from the documentation: [https://docs.nudgenow.com/](https://docs.nudgenow.com/). | |
| * Compare against Nudge’s specification from [Nudge's documentation](https://docs.nudgenow.com/){:target="_blank"} . |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * Ensure all required fields (e.g., `userId`, `event` name for Track) are present and correctly typed. | |
| * Ensure all required fields (for example, `userId`, `event` name for Track) are present and correctly typed. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| --- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.