Employments (Brazil)

Reference information for our employments (brazil) webhook events.

Historical update

As soon as your employment link is created (either recurrent or a single link with fetch_resources: ["EMPLOYMENTS"], we asynchronously load the employment record information. You will receive a historical_update notification whenever the employment record data is available for you to access.

{
   "webhook_id":"03d1ca0d62db4f769488265d141047b7",
   "webhook_type":"EMPLOYMENTS", 
   "webhook_code":"historical_update", 
   "link_id":"2f5d361d-dad6-45d4-a0bf-26d479766067",
   "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
   "external_id": "your_external_id",
   "data":{
      "total_employments": 1 // The total number of employment record profiles found for the link
   }
}

Once you receive the notification, you can get further details by making the following request:

curl --request GET 'https://api.belvo.com/api/br/employments/?link={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

Where:

{id} is the link_id you receive in your historical_update notification.

New employments available

You can receive a new_employments_available notification whenever new employment information is available for an employment recurrent link.

{
   "webhook_id":"03d1ca0d62db4f769488265d141047b7",
   "webhook_type":"EMPLOYMENTS", 
   "webhook_code":"new_employments_available", 
   "link_id":"2f5d361d-dad6-45d4-a0bf-26d479766067",
   "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
   "external_id": "your_external_id",
   "data":{
      "new_employments": 1 // Number of new employments found since last event
   }
}

Once you receive the notification, you can get further details by making the following request:

curl --request GET 'https://api.belvo.com/api/br/employments/?link={id}&created_at__range={date1},{date2}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

Where:

{id} is the link_id you received in the notification.
{date1} is the date when you previously received a notification, in YYYY-MM-DD format.
{date2} is the date you received the latest notification, in YYYY-MM-DD format.

Updated 2 months ago