Testing Your Webhook

March 26, 2020 Contributors

In addition to the validation performed when you create your webhook, you can test your webhook by posting an example message event batch to the target URL. The test sends an HTTP request to the client endpoint in the same way that the batch transmitter will. This test will validate that the target responds with an "OK" (i.e. HTTP 200) and return a detailed information response.

From the Webhooks tab, click the icon in the upper-right corner of the webhook you want to test. In the drop-down list, click Test Webhook, as shown in “Test Webhook”.

The Test Webhook window displays the example message event batch that will be posted to your target webhook, as shown in “Test Request”. The Request shows the full content of the HTTP request, which is exactly the same as what the batch transmitter would send to the client endpoint. To continue with the test, click Submit Test.

The test returns a detailed information response, as shown in “Test Response”.

The Response shows the full content of the HTTP response sent by the client endpoint after receiving the test request. It includes a standard HTTP status. In the example response, the "OK" (HTTP/1.1 200) indicates that the example message event batch was successfully posted to the target URL. Any other response code indicates some type of error.