Skip to main content
POST
Example subscription

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
events
string[]
required

identities.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://your-webhook-backend.com"

secret
string

Optional secret used to verify webhooks.

Example:

"optional-secret"

Response

200 - application/json

Webhook subscription successful

event
string

identities.updated

Example:

"identities.updated"

name
string

Name used for the webhook subscription.

Example:

"name-for-the-webhook-subscription"

data
object