Webhooks

About Webhooks

Webhooks are user-defined HTTP callbacks. They are triggered by some event in a web application and can facilitate integrating different applications or third-party APIs, like Real&Mate.

When building Real&Mate integrations, you might want your applications to receive events as they occur in your Real&Mate accounts, so that your backend systems can execute actions accordingly.

The Real&Mate uses webhooks to let your application know when events happen, such as retrieving information about real estate objects or adding new ones. When the event occurs, Real&Mate makes an HTTP request (usually a POST or a GET) to the URL you configured for the webhook. Real&Mate's request will include details of the event such as the user identifier or real estate parameters. Many other modern web services like GitHub and Slack also make use of webhooks to communicate events.

To enable webhook events, you need to register webhook endpoints. After you register them, the Real&Mate can push real-time event data to your application’s webhook endpoint when events happen in your account. Real&Mate sends webhook events to your app as a JSON payload.

Getting Started with Real&Mate Webhooks

To start receiving webhook events in your app, create and register a webhook endpoint:

1. Create a webhook endpoint handler to receive event data POST requests.
2. Test your webhook endpoint handler.
3. Register your endpoint within Real&Mate.
4. Secure your webhook endpoint.

For testing purposes during development, you may find it worthwhile to set up mock HTTP requests to your application. We suggest either using a command-line tool like curl, or a desktop application like Postman.