[Nudge] Documentation for new action destination #7676
Conversation
This file contains hidden or 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
feat: added docs for Nudge (Actions) Destination integration
fix: fixed readme manifest
stayseesong
requested changes
Jun 20, 2025
|
|
||
| ## Getting started | ||
|
|
||
| 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Nudge". |
There was a problem hiding this comment.
Suggested change
| 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*. |
| 2. Select **Nudge** and click **Add Destination**. | ||
| 3. Select an existing Source to connect to Nudge (Actions). | ||
| 4. Go to the [Nudge dashboard](https://dashboard.nudgenow.com){:target="_blank"}, and navigate to the **Settings** page. | ||
| 5. Go to the **Secret Keys** section and click on the **Create new secret key** button. |
There was a problem hiding this comment.
Suggested change
| 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**. |
| 3. Select an existing Source to connect to Nudge (Actions). | ||
| 4. Go to the [Nudge dashboard](https://dashboard.nudgenow.com){:target="_blank"}, and navigate to the **Settings** page. | ||
| 5. Go to the **Secret Keys** section and click on the **Create new secret key** button. | ||
| 6. Give appropriate name for the key, select the **Backend API** option from the permissions dropdown and create the key. |
There was a problem hiding this comment.
Suggested change
| 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. |
| 5. Go to the **Secret Keys** section and click on the **Create new secret key** button. | ||
| 6. Give appropriate name for the key, select the **Backend API** option from the permissions dropdown and create the key. | ||
| 7. Copy the generated key and store it somewhere safe for future reference. | ||
| 8. Enter the generated API key in the **Nudge** destination settings in Segment. |
There was a problem hiding this comment.
Suggested change
| 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. |
|
|
||
| ## Supported methods | ||
|
|
||
| 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/) |
There was a problem hiding this comment.
Suggested change
| 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/) |
| * Confirm you’re sending dates like `"2025-05-14T07:30:00Z"`. | ||
| * Remove any timezone offsets other than `Z` (UTC). | ||
|
|
||
| ### 3. Validation failures |
There was a problem hiding this comment.
Suggested change
| ### 3. Validation failures | |
| ### Validation failures |
Comment on lines
+76
to
+79
| * **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. |
There was a problem hiding this comment.
Suggested change
| * **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. |
|
|
||
| If requests continue to fail after checking your API key and payload: | ||
|
|
||
| * Compare against Nudge’s specification from the documentation: [https://docs.nudgenow.com/](https://docs.nudgenow.com/). |
There was a problem hiding this comment.
Suggested change
| * 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"} . |
| If requests continue to fail after checking your API key and payload: | ||
|
|
||
| * Compare against Nudge’s specification from the documentation: [https://docs.nudgenow.com/](https://docs.nudgenow.com/). | ||
| * Ensure all required fields (e.g., `userId`, `event` name for Track) are present and correctly typed. |
There was a problem hiding this comment.
Suggested change
| * 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. |
| * Compare against Nudge’s specification from the documentation: [https://docs.nudgenow.com/](https://docs.nudgenow.com/). | ||
| * Ensure all required fields (e.g., `userId`, `event` name for Track) are present and correctly typed. | ||
|
|
||
| --- |
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
This PR adds documentation for a new Action Destination: Nudge. Nudge is an AI personalization platform for marketing teams that enables rapid personalization experimentation. The documentation includes details on the Identify API and Track Event API mappings, as well as troubleshooting and contact information.
Merge timing