The work history webhook provides the work history as soon as all asynchronous processes are complete and the data becomes available. This webhook is triggered when the omni/process/imss endpoint is called and the data is done processing. This is the recommended approach for obtaining the work history data for an individual.

Work History Endpoint Details

POST https://{your-defined-url}

Request

Below is an example of the payload that you will get in when the webhook triggers

{
    "interviewId": "12fj23j2ong0fs848bfks",
    "requestId": "72456dc1-1234-567c-8b9c-10br11122f9r",
    "workHistory": {
        "name": "Marry Sue",
        "curp": "abc123",
        "apiKey": "myapikey",
        "quotedWeeks": {
            "discountedWeeks": 0,
            "listedWeeks": 131,
            "reinstatedWeeks": 0
        },
        "laborHistoryList": [
            {
                "companyName": "DIRECCION DE ADMINISTRACION CENTRAL",
                "state": "DISTRITO FEDERAL",
                "startingDate": "16/10/2021",
                "endingDate": "03/02/2023",
                "baseSalary": "$2593.5",
                "companyIMSSId": "Y123456789"
            },
            {
                "companyName": "DIRECCION DE ADMINISTRACION CENTRAL",
                "state": "DISTRITO FEDERAL",
                "startingDate": "31/08/2021",
                "endingDate": "15/09/2021",
                "baseSalary": "$2240.5",
                "companyIMSSId": "Y987654321"
            },
            {
                "companyName": "TECNOLOGIAS PUBLICA",
                "state": "DISTRITO FEDERAL",
                "startingDate": "01/07/2020",
                "endingDate": "31/08/2021",
                "baseSalary": "$2240.5",
                "companyIMSSId": "Y123459876"
            }
        ]
    }
}

If you are authenticating your webhook requests , the webhook will contain the Authorization header along with the OAuth2.0 bearer token:

Authorization: Bearer <ACCESS_TOKEN>

If you configured additional custom headers, they will be included as well.

Response

To avoid our retry policy to keep sending the same notification over and over, make sure your endpoint returns one of the following:

Status code 204 No content
Status code 200 OK with a response type application/json, for example { "success" : true }