The endpoint for the webhook should support a request to test the connection. This request is executed when the user adds the webhook information to confirm that both the URL and Secret Key were entered correctly.
Request
POST request for the same endpoint with the following variation:
- The payload is an empty object:
{} - Query string parameter
test_connection=trueis added to the URL
Response
Expecting HTTP 200. In case of an error, include a clear and actionable description of the problem in the response shown to the user.