>  Switch To Link 5 and API v2 Documentation

Pay Allocations Webhooks

Learn about pay allocations webhooks.

Pay allocation webhooks notify your system when:

  • A new pay allocation was added.
  • A pay allocation was updated.
  • A pay allocations was removed.

Pay allocations webhooks are useful to monitor individual changes to an account's pay allocations that can happen as a result of a periodic scan by Argyle, or occur because of independent changes the user makes.

To instead monitor the success of a direct deposit update you initiate, we recommend using these webhooks:



#Added

post/v1/webhooks

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.
Request body
  • #
    eventsarray of strings
    required

    pay_allocations.added

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    pay_allocations.added

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    pay_allocationstring (uuid)

    ID of the pay allocation.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v1/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["pay_allocations.added"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "pay_allocations.added",
3  "name": "A pay allocation was added",
4  "data": {
5    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
6    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
7    "pay_allocation": "4334r6e-a964-45eef6-b201-64464"
8  }
9}

#Updated

post/v1/webhooks

Implement the pay_allocations.updated webhook to know when a user updates a pay allocation.

The pay_allocations.updated webhook is triggered when:

  • Argyle updates a user's pay allocation based on details in your DDS configuration after it is confirmed by the user.
  • Periodic scans detect that the user or employer updated an existing pay allocation.
Request body
  • #
    eventsarray of strings
    required

    pay_allocations.updated

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    pay_allocations.updated

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    pay_allocationstring (uuid)

    ID of the pay_allocation.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v1/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["pay_allocations.updated"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "pay_allocations.updated",
3  "name": "A pay allocation was updated",
4  "data": {
5    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
6    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
7    "pay_allocation": "4334r6e-a964-45eef6-b201-64464"
8  }
9}

#Removed

post/v1/webhooks

Implement the pay_allocations.removed webhook to know when a user removes a pay allocation.

  • The pay_allocations.removed webhook is triggered when the user removes a pay allocation in Argyle Link.
  • Learn more in the removing bank accounts section of our direct deposit switching guide.
Request body
  • #
    eventsarray of strings
    required

    pay_allocations.removed

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    pay_allocations.removed

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    pay_allocationstring (uuid)

    ID of the pay_allocation.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v1/webhooks \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "events": ["pay_allocations.removed"],
7        "name": "name-for-the-webhook-subscription",
8        "url": "https://your-webhook-backend.com",
9        "secret": "optional-secret"
10     }'
Example Webhook
1{
2  "event": "pay_allocations.removed",
3  "name": "A pay allocation was removed",
4  "data": {
5    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
6    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
7    "pay_allocation": "4334r6e-a964-45eef6-b201-64464"
8  }
9}
Updating Argyle status...
© 2024 Argyle Systems Inc.argyle.com