Fully synced

Implement the payouts.fully_synced webhook to know when all payouts are fully scanned.

payouts.fully_synced triggers when all payouts are fully scanned. Scanning starts from the most recent payouts and finishes with the oldest ones.

This webhook only triggers when the initial scan finishes. It is not invoked during periodic scanning.

Event

payouts.fully_synced

Payload

AttributeTypeDescription
accountstring uuidID of the account the payouts were scanned from.
userstring uuidID of the user associated with the account.
available_fromstring timestampRepresents the start of the time period the payouts are available for. The available_from timestamp will precede the available_to timestamp.
available_tostring timestampRepresents the end of the time period the payouts are available for.
available_countintegerThe total number of payouts associated with the account at the moment the webhook call is made.

Examples

curl -X POST https://api.argyle.com/v1/webhooks \
  -u api_key_id:api_key_secret \
  -H "Content-Type: application/json" \
  -d '{"events": ["payouts.fully_synced"],
       "secret": "<secret for signature verification>",
         "name": "payouts.fully_synced",
          "url": "https://webhook.site/url"}'
{
    "event": "payouts.fully_synced",
    "name": "All historical data synced",
    "data": {
        "account": "12db5af4-fd5f-4d1f-bd98-0360df770aa8",
        "user": "abdb5af4-fd5f-4d1f-bd10-0360df77012c",
        "available_from": "2019-03-07T20:12:09Z",
        "available_to": "2019-09-23T23:57:31Z",
        "available_count": 432
    }
}