Skip to main content
POST
Example subscription
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:
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