Skip to main content
POST
/
v2
/
webhooks
Example subscription
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "user_forms.removed"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret"
}
'
{
  "event": "user_forms.removed",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "user_form": "0187bf23-cd80-118d-c0b8-58023e21c8e5"
  }
}
Sent when user form events occur. User forms are response forms (see Step 4) that users can submit as a fallback when they cannot find their employer or payroll provider.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

user_forms.removed

Example:
["user_forms.removed"]
​
name
string
required

Your name for the webhook subscription.

Example:

"name-for-the-webhook-subscription"

​
url
string
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. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form.

Example:

"https://your-webhook-backend.com"

​
secret
string

Optional secret used to verify webhooks.

Example:

"optional-secret"

Response

200 - application/json

Webhook subscription successful

​
event
string

user_forms.removed

Example:

"user_forms.removed"

​
name
string

Name used for the webhook subscription.

Example:

"name-for-the-webhook-subscription"

​
data
object