Skip to content

Commit 4516cf0

Browse files
Updating quickstart
1 parent d5b256b commit 4516cf0

File tree

1 file changed

+22
-35
lines changed

1 file changed

+22
-35
lines changed

docs-v2/pages/connect/quickstart.mdx

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -24,39 +24,7 @@ Here's how Connect sits in your frontend and backend, and communicates with Pipe
2424

2525
<Steps>
2626

27-
### Add the apps you want to integrate
28-
29-
1. Open an existing Pipedream project or create a new one at [https://pipedream.com/projects](https://pipedream.com/projects).
30-
2. Click the **Connect** tab, then select **Apps**.
31-
3. From here, you can add any app to your project that you want to integrate with your application.
32-
33-
There are two types of apps in Pipedream:
34-
35-
1. **Key-based**: These apps require static credentials, like API keys. Pipedream stores these credentials securely and exposes them via API.
36-
2. **OAuth**: These apps require OAuth authorization. Pipedream manages the OAuth flow for these apps, ensuring you always have a fresh access token for requests.
37-
38-
**OAuth apps require you create your own OAuth client to [deploy to production](/connect/environments):**
39-
40-
<Callout type="info">
41-
To get started in [development mode](/connect/environments), you can skip these steps. To deploy your app to production, you'll need to create an OAuth client for the app you're integrating.
42-
</Callout>
43-
44-
1. First, [create an OAuth client](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) for the app you'd like to integrate.
45-
2. Now when selecting an OAuth app in the **Apps** tab, you'll be prompted to select the OAuth client you've created.
46-
47-
### Create a Pipedream OAuth application
48-
49-
Pipedream uses OAuth to authorize requests to the REST API. To create an OAuth application:
50-
51-
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace.
52-
2. Click the **New OAuth App** button.
53-
3. Name your app and click **Create**.
54-
4. Copy the app's client secret. **It will not be accessible again**. Click **Close**.
55-
5. Copy the app's client ID from the list of OAuth applications.
56-
57-
You'll need these when configuring the SDK and making API requests.
58-
59-
### Run the Pipedream demo app or configure your own
27+
### Run the Pipedream example app or configure your own
6028

6129
You'll need to do two things to add Pipedream Connect to your app:
6230

@@ -81,10 +49,28 @@ and fill the `.env.local` file with your project and app details:
8149
# Used by `app/server.ts` to authorize requests to the Pipedream API — see below
8250
PIPEDREAM_OAUTH_CLIENT_ID=your_client_id
8351
PIPEDREAM_OAUTH_CLIENT_SECRET=your_client_secret
52+
PIPEDREAM_PROJECT_ID=your_project_id
8453
```
8554

8655
If you're building your own app, you'll need to provide these values to the environment, or retrieve them from your secrets store.
8756

57+
### Create a project in Pipedream
58+
59+
1. Open an existing Pipedream project or create a new one at [https://pipedream.com/projects](https://pipedream.com/projects).
60+
2. Click the **Settings** tab, then copy your **Project ID**.
61+
62+
### Create a Pipedream OAuth client
63+
64+
Pipedream uses OAuth to authorize requests to the REST API. To create an OAuth application:
65+
66+
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace.
67+
2. Click the **New OAuth Client** button.
68+
3. Name your client and click **Create**.
69+
4. Copy the client secret. **It will not be accessible again**. Click **Close**.
70+
5. Copy the client ID from the list.
71+
72+
You'll need these when configuring the SDK and making API requests.
73+
8874
### Generate a short-lived token
8975

9076
To securely initiate account connections for your users, you'll need generate a short-lived token for your users and use that in the [account connection flow](#connect-a-users-account). See [the docs on Connect tokens](/connect/tokens) for a general overview of why we need to create tokens and scope them to end users.
@@ -150,7 +136,7 @@ export default function Home() {
150136

151137
return (
152138
<main>
153-
<button style={{ all: "revert" }} onClick={connectAccount}>Connect your account</button>
139+
<button onClick={connectAccount}>Connect your account</button>
154140
</main>
155141
)
156142
}
@@ -567,6 +553,7 @@ response = client.get_user_accounts('USER_ID')
567553
568554
### Deploy your app to production
569555
570-
Now that you've successfully connected an account and retrieved the credentials, you're ready to deploy your app to production!
556+
- Now that you've successfully connected an account and retrieved the credentials, you're almost done!
557+
- Learn about [development environments](/connect/environments) and [using OAuth clients](/connect/oauth-clients) to deploy your app to production.
571558
572559
</Steps>

0 commit comments

Comments
 (0)