Implement the documents.removed
webhook to know when a document object is removed.
Document objects are removed when:
- The user or their employer deletes the documents from a payroll account and the Argyle API does not find them during a periodic scan of the account.
- The user or their employer deletes the payroll account that holds the documents.
Event
documents.removed
Payload
Attribute | Type | Description |
---|---|---|
account | string uuid | ID of the account the document was removed for. |
user | string uuid | ID of the user the account belongs to. |
document | string uuid | ID of the document that was removed. |
Examples
curl -X POST https://api.argyle.com/v1/webhooks \
-u api_key_id:api_key_secret \
-H "Content-Type: application/json" \
-d '{"events": ["documents.removed"],
"secret": "<secret for signature verification>",
"name": "documents.removed",
"url": "https://webhook.site/url"}'
{
"event": "documents.removed",
"name": "A document was removed",
"data": {
"account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
"user": "3823026e-a964-45f6-b201-6b8c096b30d3",
"document": "4334r6e-a964-45eef6-b201-64464"
}
}