Skip to main content

Webhooks Quick Start

This guide takes you from zero to a working webhook in a few minutes. You will create a webhook in the TestingBot member area, choose when it fires, pick a payload and verify it with a test request.

Prerequisites

  • A TestingBot account. Webhooks are configured in the members area.
  • An HTTP endpoint to receive the requests. If you do not have one yet, you can use one of the ready-made templates for services such as Slack, Microsoft Teams, Discord, PagerDuty, OpsGenie or Jira.

Create your first webhook

  1. Navigate to the Integrations page in the member area.
  2. Click the Webhooks integration.
  3. Click the Create webhook button. You can create up to 5 webhooks per team.
  4. Give the webhook a name so you can recognize it later in the overview.
  5. Choose when the webhook should fire: failures only or all tests, which test type to include (all tests, automated browser tests or real device tests), and optionally a name filter such as regression_* to only match tests or builds with a specific name pattern. See when webhooks fire for details.
  6. Pick the payload: keep the Default payload, switch to Custom and write your own JSON body with built-in variables, or click one of the Start from a template tiles to prefill everything for a popular service.
  7. Optionally configure authorization (Basic Auth or a Bearer token). In Custom payload mode you can also add extra headers and query parameters in the corresponding tabs of the form.
  8. Click Test Webhook and check the response panel to verify your endpoint accepts the request.
  9. Click Create webhook to complete the configuration. Your webhook now appears in the overview page, where you can edit or delete it.

Once these steps are completed, you will start receiving webhook requests on the URL you specified. Requests may arrive with a short delay after a test completes.

Send a test

While creating or editing a webhook, click the Test Webhook button to send a sample request to your URL right away. The test uses sample values for all variables, so you can verify your endpoint and payload without running an actual test.

The Response panel below the button shows the HTTP status of your endpoint, how long the request took, the response headers and body, and the exact payload that was sent. Use it to confirm your endpoint returns a 2xx status before saving the webhook.

Next steps

Was this page helpful?
Last updated
TestingBot Docs