Implement the activities.removed
webhook to know when an activity object is removed.
An activity object is removed when specific activities are deleted from an account by a data provider and are found to be missing during a periodic scan.
Event
activities.removed
Payload
Attributes | Type | Description |
---|---|---|
account | string uuid | ID of the account the activities were removed from. |
user | string uuid | ID of the user associated with the account. |
available_from | string timestamp | Represents the start of the time period the activities are available for. The available_from timestamp will precede the available_to timestamp. |
available_to | string timestamp | Represents the end of the time period the activities are available for. |
available_count | integer | The total number of activities associated with the account at the moment the webhook call is made. |
removed_from | string timestamp | Represents the start of the time period the activities were removed in. The removed_from timestamp will precede the removed_to timestamp. |
removed_to | string timestamp | Represents the end of the time period the activities were removed in. |
removed_count | integer | The total number of activities removed from the account at the moment the webhook call is made. |
removed_activities | array of strings | The list of IDs for activities that were 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": ["activities.removed"],
"secret": "<secret for signature verification>",
"name": "activities.removed",
"url": "https://webhook.site/url"}'
{
"name": "test",
"event": "activities.removed",
"data": {
"account": "017d9bdc-49cb-bcf6-9a99-f3ed32ddb2c2",
"user": "017d8fed-b702-7675-e9be-00d6b2d24614",
"available_from": "2019-09-03T17:56:22Z",
"available_to": "2021-12-09T00:01:01Z",
"available_count": 1237,
"removed_from": "2021-09-27T00:22:54Z",
"removed_to": "2021-09-27T00:22:54Z",
"removed_count": 1,
"removed_activities": [
"017d9f62-84e1-15ad-b269-624458d343c8"
]
}
}