Skip to content

Commit d669da2

Browse files
Danny/docs connect app configuration (#14611)
* First commit * Adding app config info * Update customize-your-app.mdx * Update docs-v2/pages/connect/use-cases.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent cb22999 commit d669da2

File tree

5 files changed

+48
-6
lines changed

5 files changed

+48
-6
lines changed

docs-v2/pages/connect/_meta.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"title": "Overview"
44
},
55
"use-cases": {
6-
"title": "Use cases"
6+
"title": "Use Cases"
77
},
88
"quickstart": {
99
"title": "Quickstart"
@@ -12,7 +12,7 @@
1212
"title": "API & SDK Reference"
1313
},
1414
"tokens": {
15-
"title": "Connect tokens"
15+
"title": "Connect Tokens"
1616
},
1717
"environments": {
1818
"title": "Environments"
@@ -26,6 +26,9 @@
2626
"connect-link": {
2727
"title": "Connect Link"
2828
},
29+
"customize-your-app": {
30+
"title": "Customize Your App"
31+
},
2932
"migrating-from-project-keys-to-oauth": {
3033
"display": "hidden"
3134
}

docs-v2/pages/connect/api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ const pd = createBackendClient({
140140

141141
await pd.invokeWorkflowForExternalUser(
142142
"enabc123", // pass the endpoint ID or full URL here
143-
"external_user_id" // The end user's ID in your system
143+
"external_user_id", // The end user's ID in your system
144144
{
145145
method: "POST",
146146
body: {
@@ -165,7 +165,7 @@ const pd = createBackendClient({
165165

166166
await pd.invokeWorkflowForExternalUser(
167167
"enabc123", // pass the endpoint ID or full URL here
168-
"external_user_id" // The end user's ID in your system
168+
"external_user_id", // The end user's ID in your system
169169
{
170170
method: "POST",
171171
body: {
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import ArcadeEmbed from '@/components/ArcadeEmbed'
2+
import Callout from '@/components/Callout'
3+
4+
# Customizing Your Application
5+
6+
<ArcadeEmbed
7+
src="https://demo.arcade.software/b3aw8YEPFavVpOrXRvca?embed"
8+
title="Pipedream Connect Auth Flow">
9+
</ArcadeEmbed>
10+
11+
<Callout type="info">
12+
By default, your end users will see a primarly Pipedream branded experience when they connect their account. To customize this screen to highlight your application, you can configure your [app's name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI.
13+
</Callout>
14+
15+
## Customizing your application details
16+
17+
Open your project in the Pipedream UI: [https://pipedream.com/projects](https://pipedream.com/projects)
18+
19+
1. Once you've opened your project, click the **Connect** tab in the left sidebar
20+
2. From there, select the **Configuration** tab
21+
22+
![Pipedream Connect Configuration](https://res.cloudinary.com/pipedreamin/image/upload/v1731045468/connect-app-config_th9fqo.png)
23+
24+
### Application name
25+
By default, your end users will see:
26+
>We use Pipedream to connect your account
27+
28+
Enter the name of your application that you'd like to show instead, so it reads:
29+
>\{Application Name\} uses Pipedream to connect your account
30+
31+
### Support email
32+
In the case of any errors during the account connection flow, by default your users will see:
33+
>Connection failed. Please retry or contact support.
34+
35+
To give your end users an email address to seek support, enter your support email. We'll display it:
36+
>Connection failed. Please retry or contact support [help@example.com](mailto:help@example.com).
37+
38+
### Logo
39+
By default we'll show Pipedream's logo alongside the app your user is connecting to. If you'd like to show your own logo instead, upload it here.

docs-v2/pages/connect/tokens.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Connect tokens
1+
# Connect Tokens
22

33
When you initiate account connection for your end users, you must either:
44

docs-v2/pages/connect/use-cases.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Pipedream Connect use cases
1+
# Pipedream Connect Use Cases
22

33
Developers use Pipedream Connect to build customer-facing API integrations into their products. It lets you build [in-app messaging](#in-app-messaging), [CRM syncs](#crm-syncs), [AI-driven products](#ai-products), and much more, all in a few minutes.
44

0 commit comments

Comments
 (0)