Skip to main content

Webhooks

You can configure webhooks for 1-Click Health: see here in the Setup guide. This allows you to receive 1-Click Health output data asynchronously. (You can alternatively poll the GET /1-click/health endpoint.)

MethodPOST
URLDefined by webhook brand setting
AuthenticationDefined by webhook brand setting (None, API Key, or Basic Auth)
Timeout30 seconds per attempt
RetriesUp to 3 attempts, with exponential backoff (about 1 second, then 2 seconds)
Expected responseRespond with a 2xx status (for example 200) to acknowledge receipt. Any other status, or a timeout, is treated as a failed delivery and retried.
DeliveryAt least once (multiple deliveries possible)
RetentionDLQ (dead letter queue) retained for 14 days

Headers

Each webhook request includes the following headers:

HeaderValueDescription
Content-Typeapplication/jsonThe payload is always sent as JSON.
User-AgentVerifiedInc-Webhook/1.0Identifies the request as coming from Verified.

Any authentication headers you configure in your webhook brand setting (API Key or Basic Auth) are also included.

Payload

GET /1-click/health Response Body
{
"event": "1-click.health.lookup",
"healthDataUuid": string,
"sentAt": integer,
...1ClickHealthEntity
}
PropertyTypeFormatDescriptionExample
eventstring-Response from the 1-Click Health lookup"1-click.health.lookup"
healthDataUuidstringVersion 4 UUIDUnique identifier for the 1ClickHealthEntity that will be returned at the end of the 1-Click Health flow"9e12fe5b-5bb8-410a-ac6b-6e053e4c7e8d"
sentAtintegerUnix time (milliseconds)When the payload was sent1760053705000
...1ClickHealthEntitySee 1ClickHealthEntity1ClickHealthEntity for the 1-Click Health flowSee 1ClickHealthEntity
Webhooks for 1-Click Signup are Coming Soon!

We don't yet support webhooks for 1-Click Signup, but those are coming soon. If you'd like to be notified when they're available, please email us at Support@Verified.inc.