Updated

Implement the payouts.updated webhook to know when a payout object is updated.

Payout objects are updated when a periodic scan detects changes to an existing payout — for example, the status of a payout execution changes from scheduled to completed.

Event

payouts.updated

Payload

AttributeTypeDescription
accountstring uuidID of the account the payouts were updated for.
userstring uuidID of the user associated with the account.
updated_fromstring timestampRepresents the start of the time period the payouts were updated in. The updated_from timestamp will precede the updated_to timestamp.
updated_tostring timestampRepresents the end of the time period the payouts were updated in.
updated_countintegerThe number of payouts that were updated.
updated_payoutsarray of uuidsIDs of the updated payouts.
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.updated"],
       "secret": "<secret for signature verification>",
         "name": "payouts.updated",
          "url": "https://webhook.site/url"}'
{
    "event": "payouts.updated",
    "name": "Payouts updated",
    "data": {
        "account": "12db5af4-fd5f-4d1f-bd98-0360df770aa8",
        "user": "abdb5af4-fd5f-4d1f-bd10-0360df77012c",
        "updated_from": "2019-09-10T10:00:00Z",
        "updated_to": "2019-09-12T12:00:00Z",
        "updated_count": 2,
        "updated_payouts": [
            "d667a477-e252-4f8a-9518-92a51b235187",
            "27f3cde1-1ca0-4b5a-940d-337fd33f97b5"
        ],
        "available_from": "2019-03-07T20:12:09Z",
        "available_to": "2019-09-23T23:57:31Z",
        "available_count": 456
    }
}