Remote - Webhook References
3. Webhook Template #
You have to develop on your side a dedicated webhook able to receive our event.
3.1 Response to Notification #
When your server receives a notification from a remote, it should always return an HTTP response.
In order to manage our system of notification it is important that your web server follows the following rules regarding HTTP status:
- HTTP 200 OK: your server has received the notification (no matter if your system failed during the processing of this notification)
- HTTP 500 Internal Server Error: the notification hasn’t been received.
Note: 200 OK should always be the response of your server if it received the notification. It should not be taken into account if your server success or not in the processing of this notification. In any case it is always possible to retrieve the state of a vehicle using the REST API.
Note 2: these HTTP status are the only one supported by our notification system. Please do not use any other HTTP status. Otherwise, it could lead to a failure regarding following notification (or retry policy).
3.2 Webhook Specification #
This web server needs to be configured to read & process our events in order that you get informed about the processing of the remote. Below is the webhook template specification, it describes the HTTP callback you will receive.
Note: HTTPS must be supported and a certificate issued by a trusted public and known CA must be provided. Indeed, the URL of your webhook have to be the same as the one specified in when you created the callback.
See Also #
Want to see what it’s look like? Browse our Standards.
Retrieve reference of this API, go to the API List.