Skip to content

Webhooks Overview

Webhooks allow your application to receive real-time notifications when calculation results are available in the HouMeerOver system. Instead of repeatedly polling the API for calculation updates, webhooks push calculation data directly to your application when a calculation completes.

What are Webhooks?

Webhooks are HTTP POST requests that HouMeerOver sends to your application when a calculation result is received from the calculation engine. This enables real-time integration and immediate response to completed calculations.

Webhook Event

The HouMeerOver system sends webhooks for a single event type:

Calculation Result Available

When a calculation is completed by the external calculation engine and the result is received by HouMeerOver, a webhook is triggered containing the complete calculation data including:

  • Subsidy amount
  • Address information (municipality, postal code, house number)
  • Calculation timestamps

Webhook Benefits

  • Real-time Updates: Receive immediate notifications when calculation results are available
  • Reduced API Calls: No need to poll the API for calculation status
  • Better User Experience: Update your UI instantly when calculations complete
  • Automated Workflows: Trigger automated processes based on completed calculations
  • Complete Data: Receive all calculation details in a single webhook payload

Getting Started

To start using webhooks with HouMeerOver:

  1. Set up webhook endpoints in your application to receive calculation results
  2. Configure webhook URLs in the HouMeerOver admin interface
  3. Handle webhook payloads containing calculation data
  4. Test your integration with webhook delivery

Security Considerations

  • All webhook requests are signed with HMAC-SHA256 signatures using the X-Webhook-Signature header
  • Webhook URLs must use HTTPS in production environments
  • Implement proper signature verification to ensure authenticity
  • Set up proper error handling and retry logic for failed deliveries
  • Webhook secrets are automatically generated per municipality

Next Steps

Support

If you encounter issues with webhooks:

  1. Review webhook delivery logs in the admin interface
  2. Contact the HouMeerOver support team for assistance

This documentation is part of the HouMeerOver Third Party Integration integration guide.