Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs-v2/pages/connect/_meta.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
{
"index": {
"title": "Overview"

Check failure on line 3 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"use-cases": {
"title": "Use cases"
"title": "Use Cases"

Check failure on line 6 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"quickstart": {
"title": "Quickstart"

Check failure on line 9 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"api": {
"title": "API & SDK Reference"

Check failure on line 12 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"tokens": {
"title": "Connect tokens"
"title": "Connect Tokens"

Check failure on line 15 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"environments": {
"title": "Environments"

Check failure on line 18 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"oauth-clients": {
"title": "OAuth Clients"

Check failure on line 21 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"webhooks": {
"title": "Webhooks"

Check failure on line 24 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"connect-link": {
"title": "Connect Link"

Check failure on line 27 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"customize-your-app": {
"title": "Customize Your App"

Check failure on line 30 in docs-v2/pages/connect/_meta.json

View workflow job for this annotation

GitHub Actions / Lint Code Base

Missing trailing comma
},
"migrating-from-project-keys-to-oauth": {
"display": "hidden"
}
Expand Down
4 changes: 2 additions & 2 deletions docs-v2/pages/connect/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ const pd = createBackendClient({

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

await pd.invokeWorkflowForExternalUser(
"enabc123", // pass the endpoint ID or full URL here
"external_user_id" // The end user's ID in your system
"external_user_id", // The end user's ID in your system
{
method: "POST",
body: {
Expand Down
39 changes: 39 additions & 0 deletions docs-v2/pages/connect/customize-your-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import ArcadeEmbed from '@/components/ArcadeEmbed'
import Callout from '@/components/Callout'

# Customizing Your Application

<ArcadeEmbed
src="https://demo.arcade.software/b3aw8YEPFavVpOrXRvca?embed"
title="Pipedream Connect Auth Flow">
</ArcadeEmbed>

<Callout type="info">
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.
</Callout>

## Customizing your application details

Open your project in the Pipedream UI: [https://pipedream.com/projects](https://pipedream.com/projects)

1. Once you've opened your project, click the **Connect** tab in the left sidebar
2. From there, select the **Configuration** tab

![Pipedream Connect Configuration](https://res.cloudinary.com/pipedreamin/image/upload/v1731045468/connect-app-config_th9fqo.png)

### Application name
By default, your end users will see:
>We use Pipedream to connect your account

Enter the name of your application that you'd like to show instead, so it reads:
>\{Application Name\} uses Pipedream to connect your account

### Support email
In the case of any errors during the account connection flow, by default your users will see:
>Connection failed. Please retry or contact support.

To give your end users an email address to seek support, enter your support email. We'll display it:
>Connection failed. Please retry or contact support [[email protected]](mailto:[email protected]).

### Logo
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.
2 changes: 1 addition & 1 deletion docs-v2/pages/connect/tokens.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Connect tokens
# Connect Tokens

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

Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/connect/use-cases.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pipedream Connect use cases
# Pipedream Connect Use Cases

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.

Expand Down
Loading