Skip to content

Commit 5d3206d

Browse files
committed
Adding Apps, Users, Webhooks docs
1 parent 3082b0c commit 5d3206d

File tree

3 files changed

+83
-2
lines changed

3 files changed

+83
-2
lines changed

docs-v2/pages/connect/connect-link.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,8 @@ https://pipedream.com/_static/connect.html?token={token}&connectLink=true&app={a
2525
**To test this code, check out this workflow:**
2626
[https://pipedream.com/new?h=tch_EvfbvQ](https://pipedream.com/new?h=tch_EvfbvQ)
2727

28-
## Success and error redirect URLs
28+
## Success and error redirect URLs
29+
30+
When you [generate a Connect link](/connect/quickstart/#how-to-generate-a-link), you can specify `success_redirect_url` and `error_redirect_url` parameters. Pipedream will redirect the end user to these URLs after they complete the connection flow, or if an error occurs. [See the API docs](/connect/api#create-a-new-token) for details.
31+
32+
In the absence of these URLs, Pipedream will redirect the user to a Pipedream-hosted success or error page at the end of the connection flow.

docs-v2/pages/connect/index.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,30 @@ Pipedream Connect lets you build any API integration into your product in minute
4141

4242
Watch [the demo](https://www.youtube.com/embed/xhUagMsogkQ) or visit [the quickstart](/connect/quickstart) to build your first integration.
4343

44+
## App configuration
45+
46+
To add a new integration:
47+
48+
1. Open your project
49+
2. Click the **Connect** tab
50+
3. In the **Apps** section, add a new app.
51+
52+
You can add any of Pipedream's [supported apps](https://pipedream.com/apps) to your project, or [request a new app here](https://pipedream.com/support).
53+
54+
When you add an app, you can choose to use either Pipedream's OAuth client (for testing) or [your own OAuth client](/connected-accounts/oauth-clients).
55+
56+
If you'd like to use Pipedream OAuth clients in production, please reach out at `[email protected]` or in our [Slack community](https://pipedream.com/support)
57+
58+
## Users
59+
60+
To view or delete your users' connected accounts:
61+
62+
1. Open your project
63+
2. Click the **Connect** tab
64+
3. In the **Apps** section, add a new app.
65+
66+
You'll see a list of all users, their connected accounts, and the option to delete any accounts from the UI.
67+
4468
## Plans and pricing
4569

4670
During the preview phase, **Connect is free to use for any workspace**.

docs-v2/pages/connect/webhooks.mdx

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,54 @@
1-
# Connect Webhooks
1+
# Connect Webhooks
2+
3+
When you [generate a Connect token](/connect/quickstart/#generate-a-token), you can pass a `webhook_uri` parameter. Pipedream will send a POST request to this URL when the user completes the connection flow, or if an error occurs at any point. [See the API docs](/connect/api#create-a-new-token) for details.
4+
5+
## Webhook events
6+
7+
- `CONNECTION_SUCCESS` - Sent when the user successfully connects their account
8+
- `CONNECTION_ERROR` - Sent when an error occurs during the connection flow
9+
10+
## Webhook payload
11+
12+
### Successful connection
13+
14+
Please note that user credentials are not sent in the webhook request. To retrieve credentials, use the [Connect API to fetch the account](/connect/api#retrieve-account-details-by-id) using the `account.id` provided in the webhook payload.
15+
16+
```json
17+
{
18+
"event": "CONNECTION_SUCCESS",
19+
"connect_token": "abc123",
20+
"environment": "production",
21+
"connect_session_id": 123,
22+
"account": {
23+
"id": "apn_abc123",
24+
"name": "My Slack workspace",
25+
"external_id": "U123456",
26+
"healthy": true,
27+
"dead": false,
28+
"app": {
29+
"id": "app_abc123",
30+
"name_slug": "slack",
31+
"name": "Slack",
32+
"auth_type": "oauth",
33+
"description": "Slack is a channel-based messaging platform",
34+
"img_src": "https://assets.pipedream.net/icons/slack.svg",
35+
"custom_fields_json": [],
36+
"categories": "Communication",
37+
},
38+
"created_at": "2021-09-01T00:00:00Z",
39+
"updated_at": "2021-09-01T00:00:00Z",
40+
}
41+
}
42+
```
43+
44+
### Error
45+
46+
```json
47+
{
48+
"event": "CONNECTION_ERROR",
49+
"connect_token": "abc123",
50+
"environment": "production",
51+
"connect_session_id": 123,
52+
"error": "You've hit your limit on the number of external users you can connect."
53+
}
54+
```

0 commit comments

Comments
 (0)