Employment metrics (Webhooks)
Reference information for our employment metrics webhook events.
Historical update
As soon as your employment link is created (for SAT Mexico) and you have added EMPLOYMENT_METRICS
to the list of resources in fetch_resources
, we asynchronously calculate the employment metrics for the link and will send you the following webhook:
Webhook Code | Description |
---|---|
historical_update | The total number of employment metrics generated for the link. |
In the webhook payload we include the number of employment metrics found for the link.
{
"webhook_id": "03d1ca0d62db4f769488265d141047b7",
"webhook_type": "EMPLOYMENT_METRICS",
"process_type": "historical_update",
"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_employment_metrics": 1 // The total number of employment metric reports generated
}
}
Once you receive the notification, you can get further details by making the following request:
curl --request GET 'https://api.belvo.com/api/employment-metrics/?link=link_id' \
-u [Secret Key ID]:[Secret Key PASSWORD]
Query Parameter | Description | Example |
---|---|---|
link | The link_id you received in the webhook notification. | 2f5d361d-dad6-45d4-a0bf-26d479766067 |
Updated about 1 month ago