Skip to content

Commit 86e7b51

Browse files
Some more docs updates
1 parent cd7ce90 commit 86e7b51

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export default function Home() {
104104

105105
## External users
106106

107-
When you use the Connect API, you'll pass an `external_id` parameter when initiating account connections and retrieving credentials. This is your user's ID, in your system — whatever you use to uniquely identify them.
107+
When you use the Connect API, you'll pass an `external_user_id` parameter when initiating account connections and retrieving credentials. This is your user's ID, in your system — whatever you use to uniquely identify them.
108108

109109
Pipedream associates this ID with user accounts, so you can retrieve credentials for a specific user, and invoke workflows on their behalf.
110110

@@ -114,7 +114,7 @@ External IDs are limited to 250 characters.
114114

115115
| API Endpoint | Rate Limit |
116116
|----------------------------|------------------------------------------------------|
117-
| `POST /tokens` | 100 requests per minute per `external_id` |
117+
| `POST /tokens` | 100 requests per minute per `external_user_id` |
118118
| `GET */accounts/*`| The sum of requests across all `*/accounts/*` endpoints must not exceed 100 requests per minute. This includes requests to `/accounts`, `/apps/:app_id/accounts`, `/accounts/:account_id`, and more — any request for account metadata and credentials is counted towards this total. |
119119

120120
If you need higher rate limits, please [reach out](https://pipedream.com/support).
@@ -722,7 +722,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account
722722
Retrieve the account details for a specific account based on the external user ID
723723

724724
```
725-
GET /{project_id}/users/{external_id}/accounts
725+
GET /{project_id}/users/{external_user_id}/accounts
726726
```
727727

728728
##### Path parameters
@@ -733,7 +733,7 @@ GET /{project_id}/users/{external_id}/accounts
733733

734734
---
735735

736-
`external_id` **string**
736+
`external_user_id` **string**
737737

738738
[The external user ID](#external-users) in your system that you want to retrieve accounts for.
739739

@@ -1095,7 +1095,7 @@ Pipedream returns a `204 No Content` response on successful account deletion
10951095
Delete an end user and all their connected accounts
10961096

10971097
```
1098-
DELETE /{project_id}/users/{external_id}
1098+
DELETE /{project_id}/users/{external_user_id}
10991099
```
11001100

11011101
##### Path parameters
@@ -1106,7 +1106,7 @@ DELETE /{project_id}/users/{external_id}
11061106

11071107
---
11081108

1109-
`external_id` **string**
1109+
`external_user_id` **string**
11101110

11111111
[The external user ID](#external-users) in your system
11121112

@@ -1162,7 +1162,7 @@ curl -X POST https://api.pipedream.com/v1/oauth/token \
11621162

11631163
# The response will include an access_token. Use it in the Authorization header below.
11641164

1165-
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/users/{external_id}" \
1165+
curl -X DELETE "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}" \
11661166
-H "Authorization: Bearer {access_token}"
11671167
```
11681168
</Tabs.Tab>

docs-v2/pages/connect/environments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Pipedream Connect projects support two environments: `development` and `production`.
44

5-
1. Credentials stored in `development` remain separate from `production`.
5+
1. Connected accounts and credentials stored in `development` remain separate from `production`.
66
2. In `development`, you can use the official Pipedream OAuth apps, so you can test integrations without creating your own OAuth client.
77

88
## How to specify environment

docs-v2/pages/connect/quickstart.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@ If you're using a different server / API framework, you'll need to make secure c
103103

104104
Once you have a token, return it to your frontend to start the account connection flow for the user, or redirect them to a Pipedream-hosted URL with [Connect Link](#use-connect-link).
105105

106+
<Callout type="info">
107+
Refer to the API docs for [all the parameters you can pass](/connect/api#create-a-new-token) in the `ConnectTokenCreate` call.
108+
</Callout>
109+
106110
### Connect a user's account
107111

108112
To connect a third-party account for a user, you have two options:

docs-v2/pages/workflows/triggers.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ To configure a static, custom token for HTTP auth:
115115
2. Select **Custom token**.
116116
3. Enter whatever secret you'd like and click **Save and Continue**.
117117

118+
![Custom token auth](https://res.cloudinary.com/pipedreamin/image/upload/v1729791152/Google_Chrome_-_Untitled_Workflow_-_10-24-2024_10-30_AM_-_Build_-_Pipedream_2024-10-24_at_10.31.01_AM_pkh8dk.png)
119+
118120
When making HTTP requests, pass the custom token as a `Bearer` token in the `Authorization` header:
119121

120122
```bash
@@ -129,6 +131,8 @@ You can also authorize requests using [Pipedream OAuth clients](/rest-api/auth#o
129131
2. Select **OAuth**.
130132
3. If you don't have an existing OAuth client, [create one in your workspace's API settings](/rest-api/auth#creating-an-oauth-application).
131133

134+
![OAuth authorization](https://res.cloudinary.com/pipedreamin/image/upload/v1729791415/Google_Chrome_-_Untitled_Workflow_-_10-24-2024_10-30_AM_-_Build_-_Pipedream_2024-10-24_at_10.36.04_AM_ujx34e.png)
135+
132136
Next, you'll need to [generate an OAuth access token](/rest-api/auth#how-to-get-an-access-token).
133137

134138
When making HTTP requests, pass the OAuth access token as a `Bearer` token in the `Authorization` header:

0 commit comments

Comments
 (0)