Troubleshooting webhooks

Integrating webhooks into your application can sometimes be challenging, and you might need help with issues while working with Webhooks.

This topic aims to help you troubleshoot any issues you may be experiencing with Webhooks. Below, you'll find a variety of common problems, detailed examples of troubleshooting, and suggested solutions to help you resolve the issue.

Webhooks are not receiving events correctly

If a webhook is not receiving events correctly, do the following:

• Verify that the webhook URL is correctly configured in the AppDirect Developer Portal.
• Check the server logs for any incoming requests from AppDirect.
• Ensure that the server hosting the webhook is accessible from the internet and is not blocked by firewalls or security settings.
• Ensure the webhook URL is using the correct HTTP method (e.g., POST) and supports HTTPS if required.

Events have incomplete or missing data

When webhook events are missing required information, do the following steps:

• Check the payload of the webhook request to ensure that all the necessary fields and data are present.
• Verify that you have subscribed to the correct events in the Developer Portal.
• Compare the received payload with the documentation to ensure you're parsing the data correctly.
• Ensure that missing fields, if any, are optional.

There are issues with Webhook authentication and validity of signature

For issues related to authentication:

• Validate the signature included in the webhook request to ensure its authenticity.
• Check if you are using the correct secret or key to verify the signature.
• Ensure that the webhook endpoint is secured and only AppDirect requests are accepted.
• Verify that the access token is valid and has sufficient permissions if you are using OAuth-based authentication.

Webhook endpoints are returning error codes

If the webhook endpoints return error codes, follow these steps:

• Check the response codes and error messages returned by the webhook endpoint.
• Review the documentation to understand the possible error scenarios and their corresponding resolutions.
• Test the webhook endpoint using tools like cURL or Postman to reproduce and troubleshoot the issue locally.
• Reach out to AppDirect support for further assistance if the issue persists.

Delivery of webhook events is delayed or inconsistent

If you observe a delay in the delivery of webhook events, follow these steps:

• Confirm that your webhook endpoint is always available and responsive.
• Monitor the network and server infrastructure for any connectivity or performance issues.
• Consider implementing a retry mechanism for failed webhook requests to ensure event delivery.
• Check for any delays on the AppDirect side and contact support for clarification if events continue to be delayed.

To get started, consider using a tool such as Webhook Tester to create a sample URL, then complete an action that generates a webhook notification. This allows you to pull the JSON to analyze what information will be sent during the events.

Additional documentation

• Webhooks API reference
• Create webhooks
• Create company-level webhooks