From 29783a22b4fa716eb69ce41d35969cdde2168367 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Thu, 7 Nov 2024 16:39:05 -0800 Subject: [PATCH 1/4] First commit --- docs-v2/pages/connect/_meta.json | 3 ++ docs-v2/pages/connect/api.mdx | 4 +-- docs-v2/pages/connect/app-configuration.mdx | 33 +++++++++++++++++++++ 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 docs-v2/pages/connect/app-configuration.mdx diff --git a/docs-v2/pages/connect/_meta.json b/docs-v2/pages/connect/_meta.json index 5034e6bc7e4a0..f69a8230c642f 100644 --- a/docs-v2/pages/connect/_meta.json +++ b/docs-v2/pages/connect/_meta.json @@ -26,6 +26,9 @@ "connect-link": { "title": "Connect Link" }, + "app-configuration": { + "title": "App Configuration" + }, "migrating-from-project-keys-to-oauth": { "display": "hidden" } diff --git a/docs-v2/pages/connect/api.mdx b/docs-v2/pages/connect/api.mdx index df9d031209eeb..469c1da5a9f03 100644 --- a/docs-v2/pages/connect/api.mdx +++ b/docs-v2/pages/connect/api.mdx @@ -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: { @@ -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: { diff --git a/docs-v2/pages/connect/app-configuration.mdx b/docs-v2/pages/connect/app-configuration.mdx new file mode 100644 index 0000000000000..a81c0e687894c --- /dev/null +++ b/docs-v2/pages/connect/app-configuration.mdx @@ -0,0 +1,33 @@ +import Image from 'next/image' + +# Configuring Your application + +By default, your end users will see this screen when they connect their account (to Google Sheets in this example): + +Pipedream Connect + +To customize this screen, you can configure your [application name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI. + +## 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 + +### 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'll read: +>\{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 [help@example.com](mailto:help@example.com). + +### Logo +By default we'll show Pipedream's logo alongside the app your use is connecting to. If you'd like to show your own logo instead, you can upload it here. \ No newline at end of file From 8617eb56649ffd4e2048b251556bd82971c72fd8 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Thu, 7 Nov 2024 21:59:58 -0800 Subject: [PATCH 2/4] Adding app config info --- docs-v2/pages/connect/_meta.json | 8 ++++---- ...nfiguration.mdx => customize-your-app.mdx} | 20 ++++++++++++------- docs-v2/pages/connect/tokens.mdx | 2 +- docs-v2/pages/connect/use-cases.mdx | 2 +- 4 files changed, 19 insertions(+), 13 deletions(-) rename docs-v2/pages/connect/{app-configuration.mdx => customize-your-app.mdx} (58%) diff --git a/docs-v2/pages/connect/_meta.json b/docs-v2/pages/connect/_meta.json index f69a8230c642f..6673166a10cb2 100644 --- a/docs-v2/pages/connect/_meta.json +++ b/docs-v2/pages/connect/_meta.json @@ -3,7 +3,7 @@ "title": "Overview" }, "use-cases": { - "title": "Use cases" + "title": "Use Cases" }, "quickstart": { "title": "Quickstart" @@ -12,7 +12,7 @@ "title": "API & SDK Reference" }, "tokens": { - "title": "Connect tokens" + "title": "Connect Tokens" }, "environments": { "title": "Environments" @@ -26,8 +26,8 @@ "connect-link": { "title": "Connect Link" }, - "app-configuration": { - "title": "App Configuration" + "customize-your-app": { + "title": "Customize Your App" }, "migrating-from-project-keys-to-oauth": { "display": "hidden" diff --git a/docs-v2/pages/connect/app-configuration.mdx b/docs-v2/pages/connect/customize-your-app.mdx similarity index 58% rename from docs-v2/pages/connect/app-configuration.mdx rename to docs-v2/pages/connect/customize-your-app.mdx index a81c0e687894c..bd7beddb2296e 100644 --- a/docs-v2/pages/connect/app-configuration.mdx +++ b/docs-v2/pages/connect/customize-your-app.mdx @@ -1,12 +1,16 @@ -import Image from 'next/image' +import ArcadeEmbed from '@/components/ArcadeEmbed' +import Callout from '@/components/Callout' -# Configuring Your application +# Customizing Your Application -By default, your end users will see this screen when they connect their account (to Google Sheets in this example): + + -Pipedream Connect - -To customize this screen, you can configure your [application name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI. + +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. + ## Customizing your application details @@ -15,11 +19,13 @@ Open your project in the Pipedream UI: [https://pipedream.com/projects](https:// 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'll read: +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 diff --git a/docs-v2/pages/connect/tokens.mdx b/docs-v2/pages/connect/tokens.mdx index fe86a0ba3c41c..4601fa6c01fa8 100644 --- a/docs-v2/pages/connect/tokens.mdx +++ b/docs-v2/pages/connect/tokens.mdx @@ -1,4 +1,4 @@ -# Connect tokens +# Connect Tokens When you initiate account connection for your end users, you must either: diff --git a/docs-v2/pages/connect/use-cases.mdx b/docs-v2/pages/connect/use-cases.mdx index 9bdcb3a7c55d7..fca83677faed5 100644 --- a/docs-v2/pages/connect/use-cases.mdx +++ b/docs-v2/pages/connect/use-cases.mdx @@ -1,4 +1,4 @@ -# Pipedream Connect use cases +# Pipedream Connect Case 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. From 686de0921382ea0ce1e33122a342bacdb4d6e867 Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Thu, 7 Nov 2024 22:04:31 -0800 Subject: [PATCH 3/4] Update customize-your-app.mdx --- docs-v2/pages/connect/customize-your-app.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-v2/pages/connect/customize-your-app.mdx b/docs-v2/pages/connect/customize-your-app.mdx index bd7beddb2296e..4443ad14f1cb8 100644 --- a/docs-v2/pages/connect/customize-your-app.mdx +++ b/docs-v2/pages/connect/customize-your-app.mdx @@ -36,4 +36,4 @@ To give your end users an email address to seek support, enter your support emai >Connection failed. Please retry or contact support [help@example.com](mailto:help@example.com). ### Logo -By default we'll show Pipedream's logo alongside the app your use is connecting to. If you'd like to show your own logo instead, you can upload it here. \ No newline at end of file +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. \ No newline at end of file From 743c023734186b63342e2bfe454c082113c9a87d Mon Sep 17 00:00:00 2001 From: Danny Roosevelt Date: Thu, 7 Nov 2024 22:05:36 -0800 Subject: [PATCH 4/4] Update docs-v2/pages/connect/use-cases.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs-v2/pages/connect/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-v2/pages/connect/use-cases.mdx b/docs-v2/pages/connect/use-cases.mdx index fca83677faed5..5d1867920331b 100644 --- a/docs-v2/pages/connect/use-cases.mdx +++ b/docs-v2/pages/connect/use-cases.mdx @@ -1,4 +1,4 @@ -# Pipedream Connect Case 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.