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/workflows.mdx
+41-2Lines changed: 41 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -199,7 +199,7 @@ curl -X POST https://{your-endpoint-url} \
199
199
</Tabs>
200
200
</Steps>
201
201
202
-
## Step configuration
202
+
## Configuring workflow steps
203
203
204
204
When configuring a workflow that's using your end user's auth instead of your own, you'll need to define most configuration fields manually in each step.
205
205
@@ -237,8 +237,47 @@ curl -X POST https://{your-endpoint-url} \
237
237
We plan to improve this interface in the future, and potentially allow developers to store end user metadata and configuration data alongside the connected account for your end users, so you won't need to pass the data at runtime.
238
238
</Callout>
239
239
240
-
## Errors
240
+
## Testing workflow steps
241
241
242
+
To test a step using the connected account of one of your end users in the builder, you'll need a few things to be configured so that your workflow knows which account to use.
243
+
244
+
**Make sure you have an external user with the relevant connected account(s) saved to your project:**
245
+
- Go to the **[Users tab](/connect#users)** in the **Connect** section of your project to confirm
246
+
- If not, either connect one from your application or [directly in the UI](#connect-a-test-account)
247
+
248
+
**Pass the environment and external user ID:**
249
+
1. Once you've added an HTTP trigger to the workflow, click **Generate test event**
250
+
<Imagesrc="https://res.cloudinary.com/pipedreamin/image/upload/v1733533191/generate-test-event-cta_emoykg.png"alt="Generate test event"width={600}height={529} />
251
+
2. Click on the **Headers** tab
252
+
3. Make sure `x-pd-environment` is set (you'll likely want to `development`)
253
+
4. Make sure to also pass `x-pd-external-user-id` with the external user ID of the user you'd like to test with
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**.
With that setting enabled on the trigger, below is an example of [this](/connect/workflows#required-account-not-found-for-external-user-id) error:
264
+
265
+
```bash
266
+
curl -X POST https://{your-endpoint-url} \
267
+
-H 'Content-Type: application/json' \
268
+
-H 'Authorization: Bearer {access_token}' \
269
+
-H "x-pd-environment: development" \
270
+
-H "x-pd-external-user-id: abc-123" \
271
+
-d '{
272
+
"slackChannel": "#general",
273
+
"messageText": "Hello, world! (sent via curl)",
274
+
"hubSpotList": "prospects",
275
+
"contactEmail": "foo@example.com"
276
+
}' \
277
+
Pipedream Connect Error: Required account forhubspot not found for external user ID abc-123in development
278
+
```
279
+
280
+
### Common errors
242
281
#### No external user ID passed, but one or more steps require it
243
282
- 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.
244
283
- [Refer to the docs](#invoke-the-workflow) to make sure you're passing external user ID correctly when invoking the workflow.
0 commit comments