Skip to content

[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

Merged
merged 13 commits into from
Jul 14, 2025
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions src/connections/destinations/catalog/actions-nudge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: Nudge (Actions) Destination
id:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
id:
id: 6863e71f2a1e1ddc4b4612bf

---

{% 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".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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**.

6. Give appropriate name for the key, select the **Backend API** option from the permissions dropdown and create the key.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/)

Copy link
Contributor Author

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### 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)**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Example (using Segment's Analytics.js SDK)**
Example (using Segment's Analytics.js SDK):


```js
analytics.identify('user123', {
name: 'Alice Smith',
email: '[email protected]',
company: 'Acme Corp',
employees: 150
});
```

How Nudge handles Identify calls:

* If `userId` does not exist, the request would throw a 400 validation error as it is a required field.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.

* 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)**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Example (using Segment's Analytics.js SDK)**
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

### 1. Events not showing up in Nudge
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 1. Events not showing up in Nudge
### Events aren't showing up in Nudge


* **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


### 2. Timestamp or date format errors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 2. Timestamp or date format errors
### 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).

### 3. Validation failures
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 3. Validation failures
### Validation failures


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/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"} .

* Ensure all required fields (e.g., `userId`, `event` name for Track) are present and correctly typed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---


*If you still encounter issues, please reach out to the Nudge Developer Team or email [[email protected]](mailto:[email protected]).*