Articles in this section

See more

QuerySurge and Webhooks (Versions: 10.0+)

QuerySurge now adds webhook support to it long-time support for email notifications, to enhance team communication and information-sharing. Out-of-the-box, QuerySurge supports notification by webhook for several popular team products via builtin webhook messages (see the Sample Webhooks listing below). You also have the option to create your own custom webhooks (see the Custom Webhooks section).

Webhook Setup

  Note: Many webhook providers require some amount of setup in order for QuerySurge (or any other external system) to send in webhook messages. For details, you'll need to consult the product documentation.

Generally, you will need to obtain the following from the webhook provider for input into QuerySurge, in order to set up your webhook:

  • a webhook URL
  • a JSON payload (the JSON structure will be Provider-dependent; consult the documentation)

You also may need (depending on the webhook Provider's requirements):

  • Credentials or a token
  • Setup for custom HTTP headers (which may involve a token)

Webhooks are fired in QuerySurge based on events. Currently, two events are available, the "Scenario Started" and "Scenario Ended" events (just like email notifications). Users may further refine the conditions under which a webhook fires by specifying Event filters (for example, based on the owner of a specific execution).

 

Sample Webhooks

QuerySurge supports the following webhook notifications via builtin handling and examples (see the linked articles for details):

Webhook Provider Released in version
Teams 10.0
Slack 10.0
Jira 10.0
Github 10.3
GitLab 10.3
TestRail 10.3

 

Custom Webhooks

Project Admin users can create custom webhooks for providers of your choice in QuerySurge, using the tools in the Project Admin view. When you create a webhook in QuerySurge, you'll need to perform the following tasks:

  • Make sure that your custom provider is properly configured to receive webhook messages from QuerySurge.
  • In the QuerySurge Admin view, Click the Add button (main panel, lower left)
  • Give your webhook a name, select an Event, add an (optional) Description.
  • Select "Other" for the Provider
  • Enter the URL for your provider - this is usually generated by the provider
  • Enter a JSON payload (this will have to comply with your provider's documentation). Use the green-plus-icon.pngtool (upper right of the Payload editor) to enter any of the available QuerySurge values in your message.
  • Add any Event Filters that you want
  • Provide authentication setup as specified by your provider. See provider documentation
  • Use the arrow to the right of the Save button to test your webhook. Any error messages should appear to the left of the Save button.

Related articles