-
Notifications
You must be signed in to change notification settings - Fork 370
[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
Open
piyush-nudge
wants to merge
6
commits into
segmentio:develop
Choose a base branch
from
nudgenow:develop
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bf1a402
feat: added docs for Nudge (Actions) Destination integration
piyush-nudge 31b38f9
Merge pull request #1 from nudgenow/feat/actions-nudge
nudgenow-admin e410ad3
fix: fixed readme manifest
piyush-nudge 140ad2d
Merge pull request #2 from nudgenow/feat/actions-nudge
dhruv-nudge a39543d
update: updated Nudge (Action) Destination docs
piyush-nudge 12efce8
Merge pull request #3 from nudgenow/update/docs
dhruv-nudge File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
95 changes: 95 additions & 0 deletions
95
src/connections/destinations/catalog/actions-nudge/index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
--- | ||
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:support@nudgenow.com). | ||
|
||
## Getting started | ||
|
||
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 **Create new secret key**. | ||
6. Give an appropriate name for the key, then 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. Paste the generated API key in the **Nudge** destination settings in Segment. | ||
|
||
## Supported methods | ||
|
||
The 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/) | ||
|
||
### Identify | ||
|
||
The Identify method lets you create or update a user in Nudge’s backend. Every Identify call should include a `userId`. See Segment's Spec for Identify for any reference: [Identify Spec](https://segment.com/docs/connections/spec/identify/) | ||
|
||
Example (using Segment's Analytics.js SDK): | ||
|
||
```js | ||
analytics.identify('user123', { | ||
name: 'Alice Smith', | ||
email: 'alice.smith@example.com', | ||
company: 'Acme Corp', | ||
employees: 150 | ||
}); | ||
``` | ||
|
||
How Nudge handles Identify calls: | ||
|
||
* If `userId` doesn't exist, the request throws a 400 validation error as it's a required field. | ||
* If `userId` already exists, Nudge merges or overwrites profile properties with the latest values. | ||
* Identify calls without `userId`, or with only `anonymousId`, are dropped. | ||
|
||
--- | ||
|
||
### Track | ||
|
||
The Track method sends custom events and their properties into Nudge. You must include `event` name in every Track call so events can be associated with the correct user. See Segment's Spec for Track for any reference: [Track Spec](https://segment.com/docs/connections/spec/track/) | ||
|
||
Example (using Segment's Analytics.js SDK): | ||
|
||
```js | ||
analytics.track('Product Viewed', { | ||
product_id: 784, | ||
product_sku: 'SH#79817' | ||
}); | ||
``` | ||
|
||
How Nudge handles Track calls: | ||
|
||
* Segment ensures the `userId` is attached to the Track call for a previously successful Identify. | ||
* Events without a valid `userId` or with only `anonymousId` are dropped. | ||
* All other event properties are ingested as event metadata and can be used for trigger conditions. | ||
|
||
|
||
{% include components/actions-fields.html %} | ||
|
||
## Troubleshooting | ||
|
||
### Events aren't showing up in Nudge | ||
|
||
Events may not show up in Nudge due to one of these reasons: | ||
* **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**: API requests to Nudge's servers without `userId`, or with only `anonymousId`, are automatically dropped. Verify your mapping includes the correct identifier field. | ||
|
||
### Timestamp or date format errors | ||
|
||
Nudge expects all date/time properties in UTC ISO-8601 format (Javascript Date object's ISO format). If you see failed events due to timestamp validation: | ||
|
||
* Confirm you’re sending dates like `"2025-05-14T07:30:00Z"`. | ||
* Remove any timezone offsets other than `Z` (UTC). | ||
|
||
### Validation failures | ||
|
||
If requests continue to fail after checking your API key and payload: | ||
|
||
* Compare against Nudge’s specification from the documentation: [Nudge's Documentation](https://docs.nudgenow.com/){:target="_blank"}. | ||
* Ensure all required fields (for example, `userId`, `event` name for Track) are present and correctly typed. | ||
|
||
|
||
*If you still encounter issues, please reach out to the Nudge Developer Team or email [support@nudgenow.com](mailto:support@nudgenow.com).* |
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.
Uh oh!
There was an error while loading. Please reload this page.