Webhook

Webhooks allow you to receive real-time HTTP notifications of changes to specific objects. For now it’s only request object in the MRV API. For example, we could send you a notification when any of your client requests changes status to "Completed" (these changes are made automatically by our system, not by client). This prevents you from having to query the MRV API for changes to objects that may or may not have happened, and helps you avoid reaching your rate limit.

Setup the Webhook

First of all, you have to get the Bearer token and client_id from previous section Accessing the API. Once you get Bearer token you can update the webhook parameter to your own MRV API client,

The <your_url> parameter depends on your route/endpoint in your system and it has to be POST method. On this <your_url> you will receive our changes.

Please make changes for the proper variables and the request have to look like this.

curl -X PATCH "https://gateway.prod.hummingbirdtech.com/api/v1/clients/{client_id}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <idToken>"
     -d '{"webhook_url": "<your_url>"}'

Webhook Response

The payload of the webhook message will be the request results, examples of which can be seen in the Request Results section.