Getting started with Webhooks

This guide has steps to help you set up webhooks in BrowserStack Test Reporting & Analytics.

Get started with templates

You can use templates to create custom payloads for specific ops monitoring or notification tools:

Get started with a default or custom payload

Follow these steps to set up a webhook using a default or custom payload:

1. Open Settings. Under Global Settings, click Webhooks, and then click Create webhook.
2. Enter a webhook name and select an event type.
3. Click Add trigger condition and configure filters from the available options.
4. Under Applicable to, click Select Projects and select the projects this webhook applies to. You must select at least one project and can select up to 30. After you select 30 projects, the remaining projects are unavailable until you clear one.
5. Select Start with default payload or click any of the available templates.
6. Select Default or Custom payload.
7. If you select the Default payload option:
   a. Select the type of Authorization.
   b. Enter the URL of the API endpoint of the application you want to connect.
   c. Expand Sample Payload body and edit the payload according to your requirement.
   d. Click Test Webhook.
8. If you select the Custom payload option:
   a. Select POST or PUT method.
   b. Enter the URL of the API endpoint of the application you want to connect.
   c. Edit the body of the payload according to your requirement. Click the Variables menu and select variables to include any variables in the payload.
   d. Select the type of Authorization.
   e. Add optional headers as key-value pairs.
   f. Add optional parameters as key-value pairs.
   g. Switch on Re-trigger webhook if the build starts passing if you want to retrigger the webhook when the build passes.
   h. Click Test Webhook.
   
9. Click Create.

View your webhooks

When you create a webhook, you can view it on the Webhooks page along with other webhooks created by the members of your team. Go to Settings, and then click Webhooks under Global Settings to view all webhooks across projects.

The list shows 20 webhooks per page and displays the following information for every webhook:

• Name and URL: the webhook name and the endpoint URL that receives the request.
• Status: whether the webhook is enabled or disabled.
• Applicable to: the projects the webhook applies to. The column shows the first project followed by a count of the remaining projects. Hover over the count to view the full list.
• Event: the event type that triggers the webhook.

To enable or disable, edit, clone, or delete a webhook, click the three-dot menu at the end of the webhook’s row. The menu shows Enable or Disable based on the current status of the webhook.

Webhooks created from a project’s settings

Webhooks that you created earlier from a project’s Settings page appear on this list, with Applicable to set to the project they were created in. They keep working as before. To extend such a webhook to more projects, click the three-dot menu, click Edit, and then select the additional projects under Applicable to.

Filter webhooks

The search box and the three filters at the top of the list help you find a webhook:

The filters work together, so you can combine them to narrow the list. For example, select a project in the project filter and then select Test Failure in the events filter to view only the test failure webhooks that apply to that project.