You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/components.mdx
+92-1Lines changed: 92 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1011,4 +1011,95 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/components/trigge
1011
1011
"created_at": 1744499847,
1012
1012
"updated_at": 1744499847
1013
1013
}
1014
-
```
1014
+
```
1015
+
1016
+
## Troubleshooting
1017
+
1018
+
### Referencing the app prop in configured props payload
1019
+
1020
+
If you encounter an error like `Cannot read properties of undefined (reading 'oauth_access_token')`, it's likely related to an incorrect reference to the app prop in your configured_props payload.
1021
+
1022
+
For example, using `google_sheets` instead of `googleSheets`, or `stripe` instead of `app`. Always use the exact app prop name as returned by the component definition.
1023
+
1024
+
The app prop name can be found in the component's definition under `configurable_props`:
1025
+
1026
+
```json
1027
+
"configurable_props": [
1028
+
{
1029
+
"name": "googleSheets", // Use this exact name in your payload
1030
+
"type": "app",
1031
+
"app": "google_sheets"
1032
+
},
1033
+
...
1034
+
]
1035
+
```
1036
+
1037
+
### Passing dynamic props ID
1038
+
1039
+
When working with components that use dynamic props, you must track and pass the `dynamicPropsId` in your API calls. After calling the API to reload props as described in the [Configure dynamic props](#configure-dynamic-props) section, you'll receive a response containing a `dynamicProps.id` value that looks like `dyp_6xUyVgQ`.
1040
+
1041
+
This ID must be included in subsequent API calls to `runAction` or `deployTrigger`. Failing to include it can result in errors like:
1042
+
1043
+
```json
1044
+
{
1045
+
"name": "Error",
1046
+
"message": "undefined is not an array or an array-like"
1047
+
}
1048
+
```
1049
+
1050
+
or
1051
+
1052
+
```json
1053
+
{
1054
+
"title": "TypeError",
1055
+
"detail": "Cannot read properties of undefined (reading 'endpoint')"
1056
+
}
1057
+
```
1058
+
1059
+
For example, after receiving the dynamic props ID from the reload props call, include it in your action execution:
1060
+
1061
+
```javascript
1062
+
// First, reload props for a component with dynamic props
Remember to maintain this ID in your application state while the user is configuring the component, and include it in all subsequent API calls related to that particular configuration.
1082
+
1083
+
### Checking source logs for deployed triggers
1084
+
1085
+
If a deployed trigger isn't emitting events as expected, you can examine the source logs to get a better sense of what's happening.
1086
+
1087
+
Use the following URL to access logs and view emitted events:
1088
+
1089
+
```
1090
+
https://pipedream.com/sources/{dcid}
1091
+
```
1092
+
1093
+
Replace `{dcid}` with your deployed component ID (e.g., `dc_dAuGmW7`).
1094
+
1095
+
The sources UI contains three tabs:
1096
+
1097
+
-**Events**: Lists emitted events from the deployed trigger that will be sent to the subscribed webhook or workflow. This helps you verify that events are being properly processed and understand their structure.
1098
+
1099
+
-**Logs**: Displays execution history for the trigger. For polling sources, this shows each time the trigger checks for updates. For webhook-based instant sources, it shows each time the source receives an event from the upstream API. This tab is especially useful for troubleshooting when events aren't being emitted as expected.
1100
+
1101
+
-**Configuration**: Provides a read-only view of the deployed source's code and configuration. While you can't modify settings for deployed triggers that belong to external users here, this tab offers insight into how the trigger is configured.
1102
+
1103
+
<Callouttype="info">
1104
+
This UI view is currently in beta and has some limitations. Some UI elements may appear unpolished, and the configuration tab has limited functionality.
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/environments.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ import Image from 'next/image'
6
6
Pipedream Connect projects support two environments: `development` and `production`. Connected accounts and credentials stored in `development` remain separate from `production`.
7
7
8
8
<Callouttype="info">
9
-
You can use all of the Connect features in `development` mode **on any plan**. **[Get in touch with our Sales team](https://pipedream.com/pricing?plan=Enterprise)** when you're ready to ship to production.
9
+
You can use all of the Connect features in `development` mode **on any plan**. **[Visit the pricing page](https://pipedream.com/pricing?plan=Connect)** to select the right plan when you're ready to ship to production.
10
10
</Callout>
11
11
12
12
## Development mode
@@ -59,7 +59,7 @@ curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
59
59
60
60
When you're ready to ship to production:
61
61
62
-
1.Contact the [Pipedream Sales team](https://pipedream.com/pricing?plan=Enterprise) to enable production access
62
+
1.Visit the [pricing page](https://pipedream.com/pricing?plan=Connect) to enable production access
63
63
2. Update your environment to `production` in your SDK client configuration and / or API calls
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Visit [the managed auth quickstart](/connect/quickstart/) to build your first in
42
42
43
43
## Plans and pricing
44
44
45
-
**Managed authentication with Connect is free to use for up to 1,000 connected accounts for any workspace**. Check out our [pricing page](https://pipedream.com/pricing?plan=Enterprise) to get in touch with our Sales team for details on using the rest of the Connect features in production.
45
+
**Connect is entirely free to get started and use in development mode**. Once you're ready to ship to production, check out our [pricing page](https://pipedream.com/pricing?plan=Connect)for the latest info.
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/workflows.mdx
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -265,9 +265,13 @@ You have two options for triggering workflows that run on behalf of your end use
265
265
266
266
The most common way to trigger workflows is via HTTP webhook. We strongly recommend [creating a Pipedream OAuth client](/rest-api/auth#creating-an-oauth-client) and authenticating inbound requests to your workflows.
267
267
268
+
<Callouttype="info">
269
+
This section refers to authenticating requests to the Pipedream API. For info on how managed auth works for your end users, refer to the [managed auth quickstart](/connect/managed-auth/quickstart).
270
+
</Callout>
271
+
268
272
To get started, you'll need:
269
273
270
-
-[OAuth client ID and secret](/rest-api/auth#creating-an-oauth-client)(optional but recommended)
274
+
-[OAuth client ID and secret](/rest-api/auth#creating-an-oauth-client)for authenticating with the Pipedream API
271
275
- Your [project ID](/projects/#finding-your-projects-id)
272
276
- Your workflow's HTTP endpoint URL
273
277
- The [external user ID](/connect/api/#external-users) of your end user
@@ -362,6 +366,18 @@ You can [programmatically deploy triggers via the API](/connect/api/#deploy-a-tr
362
366
363
367
See the [API documentation](/connect/api/#deploy-a-trigger) for detailed examples of deploying and managing triggers.
364
368
369
+
## OAuth client requirements
370
+
371
+
<Callouttype="info">
372
+
When using OAuth apps (like Google Drive, Slack, Notion, etc.) with your end users, you **must use your own custom OAuth clients**.
373
+
</Callout>
374
+
375
+
1. Register your own OAuth application with each third-party service (Google Drive, Slack, etc.)
376
+
2.[Add your OAuth client credentials to Pipedream](/apps/oauth-clients#configuring-custom-oauth-clients)
377
+
3. Make sure to include your `oauthAppId` when connecting accounts for your end users
378
+
379
+
For detailed instructions, see the [OAuth Clients documentation](/connect/managed-auth/oauth-clients#using-a-custom-oauth-client).
380
+
365
381
## Troubleshooting
366
382
367
383
For help debugging issues with your workflow, you can return verbose error messages to the caller by configuring the HTTP trigger to **Return a custom response from your workflow**.
@@ -385,8 +401,8 @@ curl -X POST https://{your-endpoint-url} \
385
401
Pipedream Connect Error: Required account forhubspot not found for external user ID abc-123in development
386
402
```
387
403
388
-
389
404
### Common errors
405
+
390
406
#### No external user ID passed, but one or more steps require it
391
407
- One or more steps in the workflow are configured to **Use end user's auth via Connect**, but no external user ID was passed when invoking the workflow.
392
408
- [Refer to the docs](#invoke-the-workflow) to make sure you're passing external user ID correctly when invoking the workflow.
@@ -400,8 +416,8 @@ Pipedream Connect Error: Required account for hubspot not found for external use
400
416
- You can check which connected accounts are available for that user [in the UI](/connect/managed-auth/users/) or [via the API](/connect/api/#accounts).
401
417
402
418
#### Running workflows for your users in production requires a higher tier plan
403
-
- Anyone is able to run workflows foryour end usersin`development`. The Business plan is required to run on behalf of `production` users.
404
-
- Schedule a call with our sales team and learn more about pricing [here](https://pipedream.com/pricing?plan=Enterprise).
419
+
- Anyone is able to run workflows foryour end usersin`development`.
420
+
- Visit the [pricing page](https://pipedream.com/pricing?plan=Connect) forthe latest info on using Connectin production.
0 commit comments