Skip to main content
POST
Example subscription
Sent when a verification has been updated.

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
events
enum<string>[]
required

verifications.updated

Available options:
verifications.updated
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://webhooks.example.com/argyle/verifications-updated"

secret
string

Optional secret used to verify webhooks.

Example:

"secret-value"

config
object

"include_resource": true will return the verification object in the response within a resource object.

Example:

Response

200 - application/json
event
string

verifications.updated

name
string

Name used for the webhook subscription.

data
object