Skip to content

Commit 12efce8

Browse files
authored
Merge pull request #3 from nudgenow/update/docs
update: updated Nudge (Action) Destination docs
2 parents 140ad2d + a39543d commit 12efce8

File tree

1 file changed

+16
-18
lines changed
  • src/connections/destinations/catalog/actions-nudge

1 file changed

+16
-18
lines changed

src/connections/destinations/catalog/actions-nudge/index.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ This destination is maintained by the Nudge Developer Team. For any issues with
1111

1212
## Getting started
1313

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**.
1515
2. Select **Nudge** and click **Add Destination**.
1616
3. Select an existing Source to connect to Nudge (Actions).
1717
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.
2020
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.
2222

2323
## Supported methods
2424

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

2727
### Identify
2828

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

31-
**Example (using Segment's Analytics.js SDK)**
31+
Example (using Segment's Analytics.js SDK):
3232

3333
```js
3434
analytics.identify('user123', {
@@ -41,7 +41,7 @@ analytics.identify('user123', {
4141

4242
How Nudge handles Identify calls:
4343

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.
4545
* If `userId` already exists, Nudge merges or overwrites profile properties with the latest values.
4646
* Identify calls without `userId`, or with only `anonymousId`, are dropped.
4747

@@ -51,7 +51,7 @@ How Nudge handles Identify calls:
5151

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

54-
**Example (using Segment's Analytics.js SDK)**
54+
Example (using Segment's Analytics.js SDK):
5555

5656
```js
5757
analytics.track('Product Viewed', {
@@ -71,27 +71,25 @@ How Nudge handles Track calls:
7171

7272
## Troubleshooting
7373

74-
### 1. Events not showing up in Nudge
74+
### Events aren't showing up in Nudge
7575

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

81-
### 2. Timestamp or date format errors
80+
### Timestamp or date format errors
8281

8382
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:
8483

8584
* Confirm you’re sending dates like `"2025-05-14T07:30:00Z"`.
8685
* Remove any timezone offsets other than `Z` (UTC).
8786

88-
### 3. Validation failures
87+
### Validation failures
8988

9089
If requests continue to fail after checking your API key and payload:
9190

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

95-
---
9694

9795
*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)