Debugging Webhooks

If you're encountering errors integrating with webhooks there are several steps which may help debug the issue:

  • Using our webhook "test" functionality within the Platform
  • Using a HTTP/API debugging tool such as Postman

Using the Platform Test Functionality

  • Log into the Tive platform as an account administrator
  • Open the "Webhooks" screen in the "Organization" view
    • In the upper right corner of the screen click on your user icon on the toolbar and select "Organization"
    • Click on the "Webhooks" tab
  • Click on the webhook you'd like to test
  • Click the ellipsis "..." button in the upper right corner of the webhook panel and select "Test"
  • Click the "Run Test" button
  • The HTTP "Status" and "Message" should appear in the modal.
    • If there is an issue contacting the URL you specified may see a status like 408. This indicates the URL you've specified may have a mistake in it, or network access to the server is being blocked. Ensure the URL you've specified is correct and that traffic from 34.195.102.163 is allowed to access your server.
    • Any other status is being returned from your server and you should be able to refer to your logs to determine the issue but these are the most common return codes and what they mean on most web servers:
      • 200: The server received the message successfully
      • 401 or 403: There is an authentication issue and your server does not believe the message is from a trusted source. If your service requires a specific header to authenticate ensure it is set correctly in the webhook configuration screen (be careful of leading and trailing spaces that may have been pasted in).
      • Other 400-499 codes: There's something else wrong with the request. Ensure the webhook configuration matches what is expected, the HTTP method, content type, HTTP headers, and URL.
      • 500-599 : Your server is encountering an unexpected error and you may need to search your logs to determine the root cause.

Debugging Using an HTTP/API Debugging Tool

You can simulate a webhook request to your API with tools such as Postman. Ensure the HTTP Method, content-type header, custom headers, and URL match what you've configured in the platform exactly.