Skip to content

Commit a151c9a

Browse files
committed
Document trigger listening mode
1 parent 0dd9478 commit a151c9a

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed
189 KB
Loading
299 KB
Loading

docs/triggering.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,29 @@ Webhooks are configured automatically when you [enable](./enabling.md) your work
4646
When you enable your %WORKFLOW%, the runner will automatically create a webhook in the third-party application to listen for events.
4747
When an event occurs, the third-party application will send a request to your %WORKFLOW%'s webhook URL, triggering the %WORKFLOW% to run.
4848

49+
### Testing webhook-based app event triggers
50+
51+
After configuring a trigger that uses webhooks, you can test and capture webhook requests using the **Test** tab in the trigger's configuration drawer.
52+
You can see your %WORKFLOW%'s unique test webhook URLs, by clicking **Webhook URLs**.
53+
54+
![Testing webhook-based app event triggers](./assets/triggering/test-webhook-drawer.png)
55+
56+
Click **Enter Listening Mode** to have your %WORKFLOW% listen for incoming webhook requests at the test URL.
57+
58+
Some triggers will automatically configure webhooks in the third-party app when **listening mode** is enabled.
59+
Other third-party apps may require you to manually configure the webhook in their settings.
60+
61+
Once the webhook is configured, you can generate a test event in the third-party application to send a webhook request to your %WORKFLOW%'s test URL.
62+
In the example here, we marked a task as complete in Asana, which caused Asana to send a webhook request to our %WORKFLOW%'s test URL.
63+
64+
![Captured webhook request](./assets/triggering/test-webhook-listening-mode.png)
65+
66+
We can save the captured webhook request for use in testing our %WORKFLOW% by giving it a name and clicking **Save**.
67+
We can then use that saved webhook request and use it later in our testing.
68+
Saved payloads are available in the **Test** tab of the trigger's configuration drawer under **Saved Payloads**, and you can run your %WORKFLOW% using that payload by clicking **Run** button that appears when your mouse overs over the payload.
69+
70+
If you would like to test your %WORKFLOW% with a custom webhook payload, you can click **Configure Payload** to edit the payload data.
71+
4972
### App event triggers with polling
5073

5174
Some applications do not support webhooks, or webhook configuration is tedious.

0 commit comments

Comments
 (0)