Skip to content

Commit 7cfd4e9

Browse files
committed
Adding /apps APIs, new /accounts params, changing include_credentials to boolean, removing pricing
1 parent 4516cf0 commit 7cfd4e9

File tree

3 files changed

+167
-39
lines changed

3 files changed

+167
-39
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -315,9 +315,9 @@ GET /{project_id}/accounts/
315315

316316
##### Query parameters
317317

318-
`include_credentials` **number** (_optional_).
318+
`include_credentials` **boolean** (_optional_)
319319

320-
Pass `include_credentials=1` as a query-string parameter to include the account credentials in the response
320+
Pass `include_credentials=true` as a query-string parameter to include the account credentials in the response
321321

322322
##### Examples
323323

@@ -336,7 +336,7 @@ const pd = createClient({
336336
});
337337

338338
const accounts = await pd.getAccounts({
339-
include_credentials: 1, // set to 1 to include credentials
339+
include_credentials: true, // set to true to include credentials
340340
});
341341

342342
// Parse and return the data you need. These may contain credentials,
@@ -355,7 +355,7 @@ const pd = createClient({
355355
});
356356

357357
const accounts = await pd.getAccounts({
358-
include_credentials: 1, // set to 1 to include credentials
358+
include_credentials: true, // set to true to include credentials
359359
});
360360

361361
// Parse and return the data you need. These may contain credentials,
@@ -375,7 +375,7 @@ curl -X POST https://api.pipedream.com/v1/oauth/token \
375375

376376
# The response will include an access_token. Use it in the Authorization header below.
377377

378-
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/?include_credentials=0" \
378+
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/?include_credentials=true" \
379379
-H "Authorization: Bearer {access_token}"
380380
```
381381
</Tabs.Tab>
@@ -477,9 +477,9 @@ The `oauth_app_id` for [OAuth apps](/connect/quickstart#creating-a-custom-oauth-
477477

478478
##### Query parameters
479479

480-
`include_credentials` **number** (_optional_)
480+
`include_credentials` **boolean** (_optional_)
481481

482-
Pass `include_credentials=1` as a query-string parameter to include the account credentials in the response
482+
Pass `include_credentials=true` as a query-string parameter to include the account credentials in the response
483483

484484
##### Examples
485485

@@ -498,7 +498,7 @@ const pd = createClient({
498498
});
499499

500500
const accounts = await pd.getAccountsByApp(appId, {
501-
include_credentials: 1, // set to 1 to include credentials
501+
include_credentials: true, // set to true to include credentials
502502
});
503503

504504
// Parse and return the data you need. These may contain credentials,
@@ -517,7 +517,7 @@ const pd = createClient({
517517
});
518518

519519
const accounts = await pd.getAccountsByApp(appId, {
520-
include_credentials: 1, // set to 1 to include credentials
520+
include_credentials: true, // set to true to include credentials
521521
});
522522

523523
// Parse and return the data you need. These may contain credentials,
@@ -537,7 +537,7 @@ curl -X POST https://api.pipedream.com/v1/oauth/token \
537537

538538
# The response will include an access_token. Use it in the Authorization header below.
539539

540-
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/apps/{app_id}/accounts?include_credentials=1" \
540+
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/apps/{app_id}/accounts?include_credentials=true" \
541541
-H "Authorization: Bearer {access_token}"
542542
```
543543
</Tabs.Tab>
@@ -591,9 +591,9 @@ The ID of the account you want to retrieve
591591

592592
##### Parameters
593593

594-
`include_credentials` **number** (_optional_)
594+
`include_credentials` **boolean** (_optional_)
595595

596-
Pass `include_credentials=1` as a query-string parameter to include the account credentials in the response.
596+
Pass `include_credentials=true` as a query-string parameter to include the account credentials in the response.
597597

598598
##### Examples
599599

@@ -612,7 +612,7 @@ const pd = createClient({
612612
});
613613

614614
const account = await pd.getAccount(accountId, {
615-
include_credentials: 1, // set to 1 to include credentials
615+
include_credentials: true, // set to true to include credentials
616616
});
617617

618618
// Parse and return the data you need. These may contain credentials,
@@ -633,7 +633,7 @@ const pd = createClient({
633633
const accountId = "{account_id}"; // Replace with your account ID
634634

635635
const account = await pd.getAccount(accountId, {
636-
include_credentials: 1, // set to 1 to include credentials
636+
include_credentials: true, // set to true to include credentials
637637
});
638638

639639
// Parse and return the data you need. These may contain credentials,
@@ -653,7 +653,7 @@ curl -X POST https://api.pipedream.com/v1/oauth/token \
653653

654654
# The response will include an access_token. Use it in the Authorization header below.
655655

656-
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}?include_credentials=1" \
656+
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}?include_credentials=true" \
657657
-H "Authorization: Bearer {access_token}"
658658
```
659659
</Tabs.Tab>
@@ -685,7 +685,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/{account
685685
}
686686
```
687687

688-
##### Example Response (with `include_credentials=1`)
688+
##### Example Response (with `include_credentials=true`)
689689

690690
```json
691691
{
@@ -739,9 +739,9 @@ GET /{project_id}/users/{external_user_id}/accounts
739739

740740
##### Query parameters
741741

742-
`include_credentials` **number** (_optional_)
742+
`include_credentials` **boolean** (_optional_)
743743

744-
Pass `include_credentials=1` as a query-string parameter to include the account credentials in the response.
744+
Pass `include_credentials=true` as a query-string parameter to include the account credentials in the response
745745

746746
##### Examples
747747

@@ -760,7 +760,7 @@ const pd = createClient({
760760
});
761761

762762
await pd.getAccountsByExternalId(externalId, {
763-
include_credentials: 1, // set to 1 to include credentials
763+
include_credentials: true, // set to true to include credentials
764764
})
765765

766766
// Parse and return the data you need. These may contain credentials,
@@ -781,7 +781,7 @@ const pd = createClient({
781781
const externalId = "{external_user_id}"; // Replace with your external user ID
782782

783783
const accounts = await pd.getAccountsByExternalId(externalId, {
784-
include_credentials: 1, // set to 1 to include credentials
784+
include_credentials: true, // set to true to include credentials
785785
});
786786

787787
// Parse and return the data you need. These may contain credentials,
@@ -801,7 +801,7 @@ curl -X POST https://api.pipedream.com/v1/oauth/token \
801801

802802
# The response will include an access_token. Use it in the Authorization header below.
803803

804-
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}/accounts?include_credentials=1" \
804+
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}/accounts?include_credentials=true" \
805805
-H "Authorization: Bearer {access_token}"
806806
```
807807
</Tabs.Tab>
@@ -864,7 +864,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/users/{external_u
864864
]
865865
```
866866

867-
##### Example Response (with `include_credentials=1`)
867+
##### Example Response (with `include_credentials=true`)
868868

869869
```json
870870
[

docs-v2/pages/connect/index.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@ import VideoPlayer from "@/components/VideoPlayer";
55

66
# Pipedream Connect
77

8-
<Callout type="info">
9-
**Pipedream Connect is currently in preview, and we're looking for design partners to pair with us on the product roadmap and provide feedback**. If you're building apps, AI agents, or anything else that needs to integrate with many third-party APIs, please reach out at `[email protected]` or in our [Slack community](https://pipedream.com/support).
10-
11-
During the preview phase, Connect is free to use for any workspace. The API may change without notice, which may cause breaking changes. We'll do our best to communicate these changes. Please let us know how you're using it, what's not working, and what else you'd like to see.
12-
</Callout>
13-
148
Pipedream Connect is the easiest way for your users to connect to [over {process.env.PUBLIC_APPS}+ APIs](https://pipedream.com/apps), **right in your product**. You can build in-app messaging, CRM syncs, AI agents, [and much more](/connect/use-cases), all in a few minutes. Visit [the quickstart](/connect/quickstart) to build your first integration.
159

1610
You have full, code-level control over how these integrations work in your app. You handle your product, Pipedream simplifies the integration.
@@ -65,9 +59,7 @@ You'll see a list of all users, their connected accounts, and the option to dele
6559

6660
## Plans and pricing
6761

68-
During the preview phase, **Connect is free to use for any workspace**.
69-
70-
Please let us know if you have any feedback on the value of Connect and how you'd like to see it priced.
62+
**Connect is free to use for any workspace**.
7163

7264
## Security
7365

0 commit comments

Comments
 (0)