Skip to content

Commit 708c073

Browse files
Adding a couple visuals
1 parent f4f3859 commit 708c073

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs-v2/pages/connect/api-proxy.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The Connect proxy enables you to interface with any integrated API and make auth
1717
- The proxy sends the request to the downstream API and dynamically inserts your end user's auth credentials
1818
- The proxy returns the response from the downstream API back to you
1919

20-
[include a diagram here]
20+
![Connect API proxy visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1738734958/pd-connect-proxy-viz_y8fzuk.png)
2121

2222
<Callout type="info">
2323
Before getting started with the Connect proxy, make sure you've already gone through the [managed auth quickstart](/connect/managed-auth/quickstart) for Pipedream Connect.
@@ -49,10 +49,8 @@ You can send requests to the Connect proxy using the [Pipedream SDK](/connect/sd
4949

5050
**Headers**
5151

52-
- If using the REST API, include the `Authorization` header with your Pipedream OAuth access token (`Bearer {access_token}`). **This does not get forwarded to the downstream API.**
53-
- Any other headers you include will be forwarded to the downstream API, with the exception of those with the `x-pd-` prefix
54-
- For downstream API headers, don't prepend with anything, and we'll forward them as-is. For example:
55-
52+
- If using the REST API, include the `Authorization` header with your Pipedream OAuth access token (`Bearer {access_token}`)
53+
- Only headers that contain the prefix `x-pd-proxy` will get forwarded to the downstream API
5654

5755
<Tabs items={['Node.js', 'HTTP (cURL)']}>
5856

@@ -69,15 +67,15 @@ const pd = createBackendClient({
6967
},
7068
});
7169

72-
const url = "https://slack.com/api/chat.postMessage"
73-
const options = {
70+
const url = "https://slack.com/api/chat.postMessage" // No need to Base64 encode the URL if using the SDK
71+
const params = {
7472
account_id: "{account_id}", // The account ID for your end user (ex, apn_1234567)
7573
external_user_id: "{external_user_id}", // The external user ID for your end user
7674
}
7775

7876
const resp = await pd.makeProxyRequest(
7977
url,
80-
options,
78+
params,
8179
{
8280
method: "POST",
8381
body: {

docs-v2/pages/connect/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import VideoPlayer from "@/components/VideoPlayer";
77

88
**Connect provides a developer toolkit that lets you add {process.env.PUBLIC_APPS}+ integrations to your app or AI agent.** You can build AI agents, in-app messaging, CRM syncs, [and much more](/connect/use-cases), all in a few minutes. You have full, code-level control over how these integrations work in your app. You handle your product, Pipedream simplifies the integration.
99

10+
![Connect visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1738731467/pd-connect-viz_cep0uq.png)
11+
1012
## Use managed auth
1113

1214
- Handle authorization or accept API keys on behalf of your users, for any of Pipedream's [{process.env.PUBLIC_APPS}+ APIs](https://pipedream.com/apps)

docs-v2/pages/connect/managed-auth/_meta.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ export default {
22
"index": "Overview",
33
"users": "Users",
44
"quickstart": "Quickstart",
5-
"tokens": "Connect Tokens",
6-
"connect-link": "Connect Link",
7-
"oauth-clients": "OAuth Clients",
5+
"tokens": "Connect tokens",
6+
"connect-link": "Connect link",
7+
"oauth-clients": "OAuth clients",
88
"webhooks": "Webhooks",
9-
"customization": "Customization",
9+
"customization": "Customizing the auth flow",
1010
} as const

0 commit comments

Comments
 (0)