Skip to content

Commit dac3f01

Browse files
authored
Merge pull request #7676 from nudgenow/develop
[Nudge] Documentation for new action destination
2 parents 1e3f641 + 0c9250e commit dac3f01

File tree

1 file changed

+98
-0
lines changed
  • src/connections/destinations/catalog/actions-nudge

1 file changed

+98
-0
lines changed
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: Nudge (Actions) Destination
3+
id: 6863e71f2a1e1ddc4b4612bf
4+
private: true
5+
beta: true
6+
hidden: true
7+
---
8+
9+
{% include content/plan-grid.md name="actions" %}
10+
11+
[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.
12+
13+
This destination is maintained by the Nudge Developer Team. For any issues with the destination, [contact the Support team](mailto:[email protected]).
14+
15+
## Getting started
16+
17+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for **Nudge**.
18+
2. Select **Nudge** and click **Add Destination**.
19+
3. Select an existing Source to connect to Nudge (Actions).
20+
4. Go to the [Nudge dashboard](https://dashboard.nudgenow.com){:target="_blank"}, and navigate to the **Settings** page.
21+
5. Go to the **Secret Keys** section and click **Create new secret key**.
22+
6. Give an appropriate name for the key, then select the **Backend API** option from the permissions dropdown and create the key.
23+
7. Copy the generated key and store it somewhere safe for future reference.
24+
8. Paste the generated API key in the **Nudge** destination settings in Segment.
25+
26+
## Supported methods
27+
28+
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/)
29+
30+
### Identify
31+
32+
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](/docs/connections/spec/identify/)
33+
34+
Example (using Segment's Analytics.js SDK):
35+
36+
```js
37+
analytics.identify('user123', {
38+
name: 'Alice Smith',
39+
40+
company: 'Acme Corp',
41+
employees: 150
42+
});
43+
```
44+
45+
How Nudge handles Identify calls:
46+
47+
* If `userId` doesn't exist, the request throws a 400 validation error as it's a required field.
48+
* If `userId` already exists, Nudge merges or overwrites profile properties with the latest values.
49+
* Identify calls without `userId`, or with only `anonymousId`, are dropped.
50+
51+
---
52+
53+
### Track
54+
55+
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](/docs/connections/spec/track/)
56+
57+
Example (using Segment's Analytics.js SDK):
58+
59+
```js
60+
analytics.track('Product Viewed', {
61+
product_id: 784,
62+
product_sku: 'SH#79817'
63+
});
64+
```
65+
66+
How Nudge handles Track calls:
67+
68+
* Segment ensures the `userId` is attached to the Track call for a previously successful Identify.
69+
* Events without a valid `userId` or with only `anonymousId` are dropped.
70+
* All other event properties are ingested as event metadata and can be used for trigger conditions.
71+
72+
73+
{% include components/actions-fields.html %}
74+
75+
## Troubleshooting
76+
77+
### Events aren't showing up in Nudge
78+
79+
Events may not show up in Nudge due to one of these reasons:
80+
* **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.
81+
* **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.
82+
83+
### Timestamp or date format errors
84+
85+
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:
86+
87+
* Confirm you’re sending dates like `"2025-05-14T07:30:00Z"`.
88+
* Remove any timezone offsets other than `Z` (UTC).
89+
90+
### Validation failures
91+
92+
If requests continue to fail after checking your API key and payload:
93+
94+
* Compare against Nudge’s specification from the documentation: [Nudge's Documentation](https://docs.nudgenow.com/){:target="_blank"}.
95+
* Ensure all required fields (for example, `userId`, `event` name for Track) are present and correctly typed.
96+
97+
98+
*If you still encounter issues, please reach out to the Nudge Developer Team or email [[email protected]](mailto:[email protected]).*

0 commit comments

Comments
 (0)