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/pendo/index.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: Pendo Destination
5
5
6
6
[Pendo](http://www.pendo.io/) is a product cloud that helps product teams deliver software users love. With Pendo, product teams can understand product usage, collect feedback, measure NPS, onboard users, and announce new features in app—all without requiring engineering resources.
7
7
8
-
This destination is maintained by Pendo. For any issues with the destination, [contact the Pendo Support team](https://help.pendo.io/).
8
+
Pendo maintains this destination. For any issues with the destination, [contact the Pendo Support team](https://help.pendo.io/).
9
9
10
10
## Getting Started
11
11
@@ -19,21 +19,21 @@ Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.j
19
19
20
20
This pulls in all page and click events without needing to make additional method calls.
21
21
22
-
### Server
22
+
### Cloud-mode configuration
23
23
24
-
If you are implementing server-side, follow the steps above to add Pendo continue with steps below to add a Webhook destination:
24
+
To add the Pendo destination using Cloud-mode, use the [Webhooks](/docs/connections/destinations/catalog/webhooks) destination to enable Segment to send data to Pendo through a webhook.
25
25
26
26
1. From the Segment web app, click **Catalog**.
27
-
2. Search for "Webhooks" in the Catalog, select it, and choose which of your Javascript sources to connect the destination to.
27
+
2. Search for **Webhooks** in the Catalog, select it, and choose which of your Javascript sources to connect the destination to.
28
28
3. Add the following as your Webhook URL: `https://pendo-io.appspot.com/data/segmentio/YOUR_PENDO_API_KEY` and replace `YOUR_PENDO_API_KEY` with your actual Pendo API Key which you can find in the Pendo UI under [Site Settings](https://app.pendo.io/admin) > Basic Information > API Key.
29
29
4. Headers are not required in Webhook configuration. Once you're done adding in your URL, save changes.
30
30
5. Using Track method also requires a setting enabled on your Pendo subscription. contact Pendo to enable this feature flag for your account.
31
31
32
-
To learn more about server-side data to Pendo, check out their [support documentation](https://help.pendo.io/resources/support-library/integrations/segment-integration.html#send-server-side-data-to-pendo).
32
+
To learn more about server-side data to Pendo, see Pendo's [support documentation](https://help.pendo.io/resources/support-library/integrations/segment-integration.html#send-server-side-data-to-pendo){:target = "_blank"}.
33
33
34
34
## Identify
35
35
36
-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
36
+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
When you send an Identify call, we will pass that user's information to Pendo with `userId` as Pendo's visitor ID. User traits that you pass are mapped to visitor metadata in Pendo.
47
+
When you send an Identify call, Segment passes that user's information to Pendo with `userId` as Pendo's visitor ID. User traits that you pass are mapped to visitor metadata in Pendo.
48
48
49
49
50
50
## Group
51
51
52
-
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](https://segment.com/docs/connections/spec/group/) does. An example call would look like:
52
+
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does. An example call would look like:
When you send a Group call, we will send`groupId` as the Pendo as account ID. Group traits are mapped to account metadata in Pendo. If you are using Pendo account data, group calls (fields `groupId` & `traits`) are required.
63
+
When you send a Group call, Segment sends`groupId` as the Pendo as account ID. Group traits are mapped to account metadata in Pendo. If you are using Pendo account data, group calls (fields `groupId` & `traits`) are required.
64
64
65
65
## Track
66
66
67
-
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
67
+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
68
68
69
69
```javascript
70
70
analytics.track("Registered", {
@@ -74,6 +74,6 @@ analytics.track("Registered", {
74
74
});
75
75
```
76
76
77
-
When you send a Track call, we will send it as a Pendo Track Event. Note that `groupId` is not included by default in a Track call, but it is highly recommended to add as a property.
77
+
When you send a Track call, Segment sends it as a Pendo Track Event. Note that `groupId` is not included by default in a Track call, but it is highly recommended to add as a property.
78
78
79
-
Pendo will map`groupId` to an account ID. For more information on Pendo's Track Events, check out their [support documentation](https://help.pendo.io/resources/support-library/integrations/track-events.html).
79
+
Pendo maps`groupId` to an account ID. For more information on Pendo's Track Events, check out their [support documentation](https://help.pendo.io/resources/support-library/integrations/track-events.html).
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/webhooks/index.md
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@ title: Webhooks Destination
4
4
---
5
5
Segment Webhooks submit real-time user data to your own HTTP endpoints. A Webhook is an HTTP callback: a simple event-notification using HTTP POST. A web application implementing Webhooks will POST a message to a URL when certain things happen.
6
6
7
-
This document was last updated on January 28, 2018. If you notice any gaps, out-dated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
8
-
9
7
## Getting Started
10
8
11
9
{% include content/connection-modes.md %}
@@ -14,17 +12,18 @@ This document was last updated on January 28, 2018. If you notice any gaps, out-
14
12
2. Search for "Webhooks" in the Catalog, select it, and choose which of your sources to connect the destination to.
15
13
3. Specify up to five different Webhook URLs, you would like to forward data to.
16
14
4. Add in any header values you would like to add to the HTTP requests
17
-
5. If you require authentication, add in a [shared secret](https://segment.com/docs/connections/destinations/catalog/webhooks/#authentication).
18
-
6.Toggle on Webhooks and we will start sending all the requests received by Segment's API.
15
+
5. If you require authentication, add in a [shared secret](/docs/connections/destinations/catalog/webhooks/#authentication).
16
+
6.Once enabled, Segment sends data to the configured webhook
19
17
20
-
**Note:** We'll send you HTTP(s) POST requests that look like the below for each type. Note with each call, you'll also receive a [`context`](/docs/connections/spec/common/#context) object that provides information about the user's device, IP address, etc. As you start experimenting, we recommend trying the Webhooks destination with [RequestBin.com](https://requestbin.com/) and [ultrahook](http://www.ultrahook.com) to immediately start seeing requests coming through.
18
+
> info ""
19
+
> **Note:** With each call, Segment sends receive a [`context`](/docs/connections/spec/common/#context) object that provides information about the user's device, IP address, etc. As you start experimenting, test the Webhooks destination with [RequestBin.com](https://requestbin.com/) and [ultrahook](http://www.ultrahook.com) to see requests as they come through.
21
20
22
21
## Webhooks timeouts
23
22
24
23
When Segment sends an event to a webhook endpoint, the service must respond within 5 seconds. If Segment does not receive a response within that period, the system logs a timeout error and [retries the event later](/docs/connections/destinations/#retries-between-segment-and-destinations).
25
24
26
25
## Page
27
-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like:
26
+
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
28
27
```
29
28
POST https://your-webhook-url.com/x
30
29
```
@@ -48,7 +47,7 @@ Content-Type: application/json
48
47
```
49
48
## Screen
50
49
51
-
If you're not familiar with the Segment Specs, take a look to understand what the [Screen method](https://segment.com/docs/connections/spec/screen/) does. An example call would look like:
50
+
If you're not familiar with the Segment Specs, take a look to understand what the [Screen method](/docs/connections/spec/screen/) does. An example call would look like:
52
51
```
53
52
POST https://your-webhook-url.com/x
54
53
```
@@ -82,7 +81,7 @@ Content-Type: application/json
82
81
```
83
82
## Identify
84
83
85
-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
84
+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
108
+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
If you're not familiar with the Segment Specs, take a look to understand what the [Alias method](https://segment.com/docs/connections/spec/alias/) does. An example call would look like:
131
+
If you're not familiar with the Segment Specs, take a look to understand what the [Alias method](/docs/connections/spec/alias/) does. An example call would look like:
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](https://segment.com/docs/connections/spec/group/) does. An example call would look like:
150
+
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does. An example call would look like:
When you create a deletion request, for each affected source that has webhooks enabled we will forward a notification so that you can kick off any automations needed on your side. An example call would look like:
178
+
When you create a deletion request, for each affected source that has webhooks enabled, Segment forwards a notification so that you can kick off any automations needed on your side. An example call would look like:
If you want to authenticate the requests being sent to your webhook endpoint, you can input a `sharedSecret` in the advanced option settings. If you provide this, we will sign your requests using the shared secret and the body of the request, and add that as the `X-Signature` header. We calculate a SHA1 digest using the shared secret and the JSON-stringified body of the request.
198
+
If you want to authenticate the requests being sent to your webhook endpoint, you can input a `sharedSecret` in the advanced option settings. If you provide this, Segment signs your requests using the shared secret and the body of the request, and add that as the `X-Signature` header. Segment calculates a SHA1 digest using the shared secret and the JSON-stringified body of the request.
200
199
201
200
An example of how one might authenticate the requests would be:
0 commit comments