You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-nudge/index.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,24 +11,24 @@ This destination is maintained by the Nudge Developer Team. For any issues with
11
11
12
12
## Getting started
13
13
14
-
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Nudge".
14
+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for **Nudge**.
15
15
2. Select **Nudge** and click **Add Destination**.
16
16
3. Select an existing Source to connect to Nudge (Actions).
17
17
4. Go to the [Nudge dashboard](https://dashboard.nudgenow.com){:target="_blank"}, and navigate to the **Settings** page.
18
-
5. Go to the **Secret Keys** section and click on the **Create new secret key** button.
19
-
6. Give appropriate name for the key, select the **Backend API** option from the permissions dropdown and create the key.
18
+
5. Go to the **Secret Keys** section and click **Create new secret key**.
19
+
6. Give an appropriate name for the key, then select the **Backend API** option from the permissions dropdown and create the key.
20
20
7. Copy the generated key and store it somewhere safe for future reference.
21
-
8.Enter the generated API key in the **Nudge** destination settings in Segment.
21
+
8.Paste the generated API key in the **Nudge** destination settings in Segment.
22
22
23
23
## Supported methods
24
24
25
-
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/)
25
+
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/)
26
26
27
27
### Identify
28
28
29
29
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/)
30
30
31
-
**Example (using Segment's Analytics.js SDK)**
31
+
Example (using Segment's Analytics.js SDK):
32
32
33
33
```js
34
34
analytics.identify('user123', {
@@ -41,7 +41,7 @@ analytics.identify('user123', {
41
41
42
42
How Nudge handles Identify calls:
43
43
44
-
* If `userId`does not exist, the request would throw a 400 validation error as it is a required field.
44
+
* If `userId`doesn't exist, the request throws a 400 validation error as it's a required field.
45
45
* If `userId` already exists, Nudge merges or overwrites profile properties with the latest values.
46
46
* Identify calls without `userId`, or with only `anonymousId`, are dropped.
47
47
@@ -51,7 +51,7 @@ How Nudge handles Identify calls:
51
51
52
52
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/)
53
53
54
-
**Example (using Segment's Analytics.js SDK)**
54
+
Example (using Segment's Analytics.js SDK):
55
55
56
56
```js
57
57
analytics.track('Product Viewed', {
@@ -71,27 +71,25 @@ How Nudge handles Track calls:
71
71
72
72
## Troubleshooting
73
73
74
-
### 1. Events not showing up in Nudge
74
+
### Events aren't showing up in Nudge
75
75
76
-
***Missing or invalid API key**
77
-
Ensure that the API key you generated under **Settings → Secret Keys → Backend API** is correctly entered in your Segment destination settings.
78
-
***Dropped Identify/Track calls**
79
-
Calls without `userId`, or with only `anonymousId`, are automatically dropped. Verify your mapping includes the correct identifier field.
76
+
Events may not show up in Nudge due to one of these reasons:
77
+
***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.
78
+
***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.
80
79
81
-
### 2. Timestamp or date format errors
80
+
### Timestamp or date format errors
82
81
83
82
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:
84
83
85
84
* Confirm you’re sending dates like `"2025-05-14T07:30:00Z"`.
86
85
* Remove any timezone offsets other than `Z` (UTC).
87
86
88
-
### 3. Validation failures
87
+
### Validation failures
89
88
90
89
If requests continue to fail after checking your API key and payload:
91
90
92
-
* Compare against Nudge’s specification from the documentation: [https://docs.nudgenow.com/](https://docs.nudgenow.com/).
93
-
* Ensure all required fields (e.g., `userId`, `event` name for Track) are present and correctly typed.
91
+
* Compare against Nudge’s specification from the documentation: [Nudge's Documentation](https://docs.nudgenow.com/){:target="_blank"}.
92
+
* Ensure all required fields (for example, `userId`, `event` name for Track) are present and correctly typed.
0 commit comments