Manage workspace webhooks

A webhook is a tool that lets NeoLoad Web send automated notifications to external servers using an HTTP request. Think of it as a messenger that sends updates about specific NeoLoad Web events, such as when a test starts or ends, to other systems.

Before you start

Only administrators can create webhooks. Webhooks apply specifically to the account and workspace where you create them. If the webhook's target server is secured, add the NeoLoad Web SaaS IP addresses to the server's allowlist to allow traffic from NeoLoad Web.

To create a webhook, follow these steps:

  1. Go to Settings in the right navigation panel, then select the Workspaces tab. The central panel lists all workspaces in your account, along with their details.

  2. From the workspace list, select the workspace where you want to create a webhook.

  3. Select the webhooks tab. If no webhooks exist, select Create a webhook.

  4. Enter a name for the webhook in the Name field.

  5. Enter the URL in the URL field. Type the server URL where the notification will go.

  6. Configure the following filters if needed:

    • Test name to filter notifications by test name.

    • Project name to filter notifications by project name.

    • Scenario name to filter notifications by scenario name.

    • Result quality status to filter notifications by passed or failed tests.

    • Max results VUs to filter notifications based on the maximum number of virtual users.

    • Result duration to filter notifications based on test duration.

  7. Select Test started or Test ended to trigger the notification.

  8. Enter the payload content in the Payload field. Match the format with what the receiving server expects.

  9. Specify the payload’s content type in the Content type field.

  10. Select Send test message to verify the URL and payload format.

  11. Select Save to create the webhook.

The new webhook appears in the webhooks list. Webhooks are enabled by default. The payload content can include NeoLoad Web variables, such as:

Variable Test starts Test ends
$(test_settings_id) Yes Yes
$(test_settings_name) Yes Yes
$(test_result_author) Yes Yes
$(test_result_name) Yes Yes
$(test_result_project) Yes Yes
$(test_result_scenario) Yes Yes
$(test_result_start_date) Yes Yes
$(test_result_duration) Yes Yes
$(test_result_max_nb_vus) Yes Yes
$(test_result_id) Yes Yes
$(test_result_status) No Yes
$(test_result_quality_status) No Yes
$(url_test_result_overview) Yes Yes
$(url_graph_overview) No Yes
$(account_name) Yes Yes
$(workspace_id) Yes Yes
$(workspace_name) Yes Yes

Note: The variable $(test_result_start_date) uses the GMT timezone.

To edit a webhook, follow these steps:

  1. Go to Settings in the right navigation panel, then select the Workspaces tab.

  2. From the workspace list, select the workspace where the webhook resides.

  3. Select the Webhooks tab.

  4. Select Edit next to the webhook you want to update.

  5. Change the webhook settings as needed.

  6. Select Save to apply your changes.

To duplicate a webhook, follow these steps:

  1. Go to Settings in the right navigation panel, then select the Workspaces tab.

  2. From the workspace list, select the workspace where the webhook resides.

  3. Select the Webhooks tab.

  4. Select Duplicate next to the webhook you want to copy.

The duplicate webhook appears in the list, ready for configuration.

To delete a webhook, follow these steps:

  1. Go to Settings in the right navigation panel, then select the Workspaces tab.

  2. From the workspace list, select the workspace where the webhook resides.

  3. Select the Webhooks tab.

  4. To delete a single webhook, select Delete next to it and confirm the action in the dialog box. Please note that to delete all webhooks in the list, select the checkbox at the top of the list, then select Delete and confirm the action.

Note: For webhooks to be able to reach out to an external URL, NeoLoad Web must provide static IPs to be able to whitelist them.