Employments Webhooks

• 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

• A new employment object is added when a new account object is created and scanned.

​

Request body

​

Webhook message

• name (string, optional): Name used for the webhook subscription.
• data (object, optional)
• account (string (uuid), optional): ID of the account.
• user (string (uuid), optional): ID of the user.
• employment (string (uuid), optional): ID of the employment.

curl --request POST \\
--url https://api.argyle.com/v1/webhooks \\
--header 'accept: application/json' \\
--header 'content-type: application/json' \\
--data '{
"events": ["employments.added"],
"name": "name-for-the-webhook-subscription",
"url": "https://your-webhook-backend.com",
"secret": "optional-secret"
}'

import requests
url = "https://api.argyle.com/v1/webhooks"
payload = {
"events": ["employments.added"],
"name": "name-for-the-webhook-subscription",
"url": "https://your-webhook-backend.com",
"secret": "optional-secret"
}
headers = {
"accept": "application/json",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)

{
"event": "employments.added",
"name": "An employment was added",
"data": {
"account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
"user": "3823026e-a964-45f6-b201-6b8c096b30d3",
"employment": "4334r6e-a964-45eef6-b201-64464"
}
},
null,
2
  

​

Updated

• Employment objects are updated through periodic scanning.

​

Request body

​

Webhook message

• name (string, optional): Name used for the webhook subscription.
• data (object, optional)
• account (string (uuid), optional): ID of the account.
• user (string (uuid), optional): ID of the user.
• employment (string (uuid), optional): ID of the employment.

curl --request POST \\
--url https://api.argyle.com/v1/webhooks \\
--header 'accept: application/json' \\
--header 'content-type: application/json' \\
--data '{
"events": ["employments.updated"],
"name": "name-for-the-webhook-subscription",
"url": "https://your-webhook-backend.com",
"secret": "optional-secret"
}'

import requests
url = "https://api.argyle.com/v1/webhooks"
payload = {
"events": ["employments.updated"],
"name": "name-for-the-webhook-subscription",
"url": "https://your-webhook-backend.com",
"secret": "optional-secret"
}
headers = {
"accept": "application/json",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)

{
"event": "employments.updated",
"name": "An employment was updated",
"data": {
"account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
"user": "3823026e-a964-45f6-b201-6b8c096b30d3",
"employment": "4334r6e-a964-45eef6-b201-64464"
}
},
null,
2