Implement the pay_allocations.added
webhook to know when a user adds a new pay allocation.
The pay_allocations.added
webhook is triggered when:
- Argyle adds a new pay allocation described in your DDS configuration after it is confirmed by the user.
- Argyle scans the user’s pay allocations for the first time.
- Periodic scans detect that the user or employer added a new pay allocation.
Event
pay_allocations.added
Payload
Attribute | Type | Description |
---|---|---|
account | string uuid | ID of the parent account. |
user | string uuid | ID of the user the account belongs to. |
pay_allocation | string uuid | ID of the pay allocation that was added. |
Examples
curl -X POST https://api.argyle.com/v1/webhooks \
-u api_key_id:api_key_secret \
-H "Content-Type: application/json" \
-d '{"events": ["pay_allocations.added"],
"secret": "<secret for signature verification>",
"name": "pay_allocations.added",
"url": "https://webhook.site/url"}'
{
"event": "pay_allocations.added",
"name": "A pay allocation was added",
"data": {
"account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
"user": "3823026e-a964-45f6-b201-6b8c096b30d3",
"pay_allocation": "4334r6e-a964-45eef6-b201-64464"
}
}