Skip to content

order.applicant.visited
Webhook

Request

Sent when the applicant visits the apply link for an order at any time before they complete the application.

Security
bearer-token
Headers
Tenant-Signaturestringrequired

Signature header in the form t=<unix_ts>,v1=<hmac_sha256_hex>. See Verifying signatures.

Example:t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9
User-Agentstringrequired

Always CheckrTenant/1.

Value:"CheckrTenant/1"
Bodyapplication/jsonrequired
idstring

Unique event id. Stable across retries — use it for idempotency on the receiving side.

Example:"evt_K9dM2pXqR4vN8tLZbWyHJa"
objectstring

Always event for webhook payloads.

Value:"event"
typestring

Event type. See the Webhooks guide for the current catalog.

Value:"order.applicant.visited"
Example:"report.completed"
created_atstring, (date-time)

UTC timestamp the event was created, in ISO-8601 format.

dataobject

Event-specific payload. Shape varies by event type — see the concrete event schemas below.

POST
order.applicant.visited
Payload
{
  "id": "evt_K9dM2pXqR4vN8tLZbWyHJa",
  "object": "event",
  "type": "order.applicant.visited",
  "created_at": "2019-08-24T14:15:22Z",
  "data": {
    "id": "ap_9f8e7d6c5b4a3210",
    "order_id": "ord_WHImYp5RjqUxBowWilloQ"
  }
}

Responses

Any 2xx response acknowledges the delivery. Non-2xx responses, network errors, and timeouts are treated as failures and retried with exponential backoff.