Webhooks

Allure TestOps allows you to send real-time notifications to external applications using webhooks. When a specified event occurs, Allure TestOps can send a POST request to a specified server, including a message with additional information (for example, the number of successfully passed tests in a closed launch).

You can set up a webhook to send messages about new launches and defects to the communication tool your team uses. Or you can send launch data to the external visualization tool for additional analysis.

Allure TestOps supports the following events for webhooks:

• launch creation and closure;
• defect creation, closure, and deletion;
• test plan creation and deletion.

To create a webhook in Allure TestOps, you need to specify the URL of the external server and select one or more events that should trigger notifications.

Creating a webhook

To add a webhook:

1. Go to Settings → Webhooks.

2. Click + Webhook.

3. In the Title field, enter a name for the webhook (for example, the name of the external application).

4. In the Endpoint field, enter the URL of the external server.

5. If needed, click + Header to add additional HTTP headers to the request.

6. Under Events, select the events you need by clicking Trigger and selecting options from the drop-down list.

   For example, if you want to send notifications about new launches and defects:

   1. Click Trigger next to Launches and select Started.
   2. Click Trigger next to Defects and select Created.

7. Configure the format of the notification message for each selected event.

   The message text can contain variables, which are specified using curly braces: {{ variableName }}. When the message is sent, these variables are automatically replaced with the relevant values. For example, {{ projectName }} will be replaced with the name of the project in which the event was triggered.

   To add variables to the text, click . To reset the text to the previous state, click .

8. For launch events, you can additionally set a filter to only receive notifications for specific launches.

9. Click Test webhook to send a test message to the specified URL.

10. Click Create to finish creating the webhook.

Message format

By default, Allure TestOps sends webhook messages as JSON objects similar to the following:

{
  "text": "Launch at 2024-10-01 22:21 closed by John Doe in the project My Project"
}

When setting up a webhook, you can customize the text of the message, including the set of variables used, or completely change the format as required by the external application.

For example, you can modify the structure of the JSON object:

{
  "user": "{{ createdBy }}",
  "date": "{{ createdDate }}",
  "text": "{{ launchName }} created"
}

Or send messages as plain text, without using JSON:

{{ launchName }} closed by {{ closedBy }}

Below you can find a list of variables that can be used in webhook messages:

Filtering launches

When creating a webhook, you can select the launches for the notifications using filters. To do this, enter one or more filter conditions in the Filters field:

1. Click the Filters field.

2. Select an attribute by which you want to filter the launches.

3. Select one or more values for the attribute.

   For example, to send notifications only for launches with a specific tag:

   1. Select Tag.
   2. Enter a tag.
   3. Press Enter.

   If you enter multiple values, notifications will be sent for launches that have at least one of the specified values.

When several attributes are specified, notifications will only be sent for launches that meet all the conditions.

For example, if you set Firefox as the value for Browser and Windows as the value for OS, notifications will be sent for launches that have both conditions met.