Configuration

Configure Webhook Destination URL

PUT https://alto.tchek.fr/apiV1/eventmanager/configwebhook

Request Body

Name	Type	Description
webhookUrlV2*	String	URL from your server
webhookHeaderKey	String	If you want us to add a header key in our http request for security reasons. This will be sent in the request header "x-api-key". e.g.: ABCDEF1234

200: OK

{
    "webhookHeaderKey": "ABCDEF1234",
    "webhookUrl": null,
    "webhookUrlV2": "https://abcdef439d74.ngrok.io"
}

Get Webhook Configuration

GET https://alto.tchek.fr/apiV1/eventmanager/configwebhook

200: OK

{
    
    // Response
    "webhookHeaderKey": "ABCDEF1234",
    "webhookUrl": null,
    "webhookUrlV2": "https://abcdef439d74.ngrok.io"

}

Subscribe to Events

PUT https://alto.tchek.fr/apiV1/eventmanager/configevent

Request Body

Name	Type	Description
eventName*	String	See below different events
webhook*	Boolean	True to enable webhook

200: OK

{
    "eventName": "newTchek",
    "webhook": true,
    "companyEmail": false,
    "companyEmailAddress": null,
    "customerEmail": false,
    "customerSMS": false,
    "senderEmail": null,
    "senderName": null
}

Example :

{
    "eventName" : "newTchek",
    "webbook":true

}

List of Events

Key	Description
newTchek	When a new inspection (AKA Tchek) is created (API & App).
detectionFinished	When our ALTO AI has finished detecting damages for an inspection.
createReport	When a user has created a report after reviewing the damages detected by ALTO AI without false positive.
shareUpdatedReport	When a user has manually shared a report after updating it.
deleteTchek	When a Tchek is deleted
tradeinVehicle	When A trade-in token is created
newDamage	When a new Damage is added by the user (webhook not available yet)

The webhook is not available yet for the following events:

Key	Description
newDamage	When a new Damage is added by the user (webhook not available yet)