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: docs-v2/pages/connect/api.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ export default function Home() {
104
104
105
105
## External users
106
106
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.
108
108
109
109
Pipedream associates this ID with user accounts, so you can retrieve credentials for a specific user, and invoke workflows on their behalf.
110
110
@@ -114,7 +114,7 @@ External IDs are limited to 250 characters.
|`POST /tokens`| 100 requests per minute per `external_id`|
117
+
|`POST /tokens`| 100 requests per minute per `external_user_id`|
118
118
|`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. |
119
119
120
120
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
722
722
Retrieve the account details for a specific account based on the external user ID
723
723
724
724
```
725
-
GET /{project_id}/users/{external_id}/accounts
725
+
GET /{project_id}/users/{external_user_id}/accounts
726
726
```
727
727
728
728
##### Path parameters
@@ -733,7 +733,7 @@ GET /{project_id}/users/{external_id}/accounts
733
733
734
734
---
735
735
736
-
`external_id`**string**
736
+
`external_user_id`**string**
737
737
738
738
[The external user ID](#external-users) in your system that you want to retrieve accounts for.
739
739
@@ -1095,7 +1095,7 @@ Pipedream returns a `204 No Content` response on successful account deletion
1095
1095
Delete an end user and all their connected accounts
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/quickstart.mdx
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,6 +103,10 @@ If you're using a different server / API framework, you'll need to make secure c
103
103
104
104
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).
105
105
106
+
<Callouttype="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
+
106
110
### Connect a user's account
107
111
108
112
To connect a third-party account for a user, you have two options:
0 commit comments