Skip to content

Commit 99164ae

Browse files
Update workflows.mdx
1 parent 44373f7 commit 99164ae

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

docs-v2/pages/connect/workflows.mdx

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ curl -X POST https://{your-endpoint-url} \
199199
</Tabs>
200200
</Steps>
201201

202-
## Step configuration
202+
## Configuring workflow steps
203203

204204
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.
205205

@@ -237,7 +237,27 @@ curl -X POST https://{your-endpoint-url} \
237237
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.
238238
</Callout>
239239

240-
## Errors
240+
## Testing workflow steps
241+
242+
To test a step that uses 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 for the test.
243+
244+
**Make sure you have an external user with the relevant connected accounts saved to your project:**
245+
- Go to the **[Users tab](/connect#users)** in the **Connect** section of your project to confirm
246+
- If not, you can [easily connect one 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+
2. Click on the **Headers** tab
251+
3. Make sure `x-pd-environment` is set (you'll likely want to `development`)
252+
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
253+
254+
## Troubleshooting
255+
256+
<Callout type="info">
257+
To return verbose error messages to the caller, configure the HTTP trigger to **Return a custom response from your workflow**.
258+
</Callout>
259+
260+
### Common errors
241261

242262
#### No external user ID passed, but one or more steps require it
243263
- 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.

0 commit comments

Comments
 (0)