Skip to content

Document trigger listening mode #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −0
Open

Document trigger listening mode #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/triggering/test-webhook-drawer.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/triggering/test-webhook-listening-mode.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions docs/triggering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,29 @@ Webhooks are configured automatically when you [enable](./enabling.md) your work
When you enable your %WORKFLOW%, the runner will automatically create a webhook in the third-party application to listen for events.
When an event occurs, the third-party application will send a request to your %WORKFLOW%'s webhook URL, triggering the %WORKFLOW% to run.

### Testing webhook-based app event triggers

After configuring a trigger that uses webhooks, you can test and capture webhook requests using the **Test** tab in the trigger's configuration drawer.
You can see your %WORKFLOW%'s unique test webhook URLs, by clicking **Webhook URLs**.

![Testing webhook-based app event triggers](./assets/triggering/test-webhook-drawer.png)

Click **Enter Listening Mode** to have your %WORKFLOW% listen for incoming webhook requests at the test URL.

Some triggers will automatically configure webhooks in the third-party app when **listening mode** is enabled.
Other third-party apps may require you to manually configure the webhook in their settings.

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

![Captured webhook request](./assets/triggering/test-webhook-listening-mode.png)

We can save the captured webhook request for use in testing our %WORKFLOW% by giving it a name and clicking **Save**.
We can then use that saved webhook request and use it later in our testing.
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.

If you would like to test your %WORKFLOW% with a custom webhook payload, you can click **Configure Payload** to edit the payload data.

### App event triggers with polling

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