>  Switch To Link 5 and API v2 Documentation

Employments Webhooks

Learn about employments webhooks.

Employments webhooks will notify your system when:

  • A new employment object is added after a newly connected payroll account is scanned with an initial scan.
  • An existing employment object is updated with new information after a periodic scan.

#Added

post/v1/webhooks

Implement the employments.added webhook to know when an employments object is added.

  • A new employment object is added when a new account object is created and scanned.
Request body
  • #
    eventsarray of strings
    required

    employments.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

    employments.added

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    employmentstring (uuid)

    ID of the employment.

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": ["employments.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": "employments.added",
3  "name": "An employment was added",
4  "data": {
5    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
6    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
7    "employment": "4334r6e-a964-45eef6-b201-64464"
8  }
9}

#Updated

post/v1/webhooks

Implement the employments.updated webhook to know when an employments object is updated.

  • Employment objects are updated through periodic scanning.
Request body
  • #
    eventsarray of strings
    required

    employments.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

    employments.updated

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    employmentstring (uuid)

    ID of the employment.

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": ["employments.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": "employments.updated",
3  "name": "An employment was updated",
4  "data": {
5    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
6    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
7    "employment": "4334r6e-a964-45eef6-b201-64464"
8  }
9}
Updating Argyle status...
© 2024 Argyle Systems Inc.argyle.com