API Reference

visit.status_changed

wbhk
visitStatusChanged

Scan.com sends an HTTP POST to the webhook_url on your api_credentials record when a
visit status changes. Your endpoint must accept JSON and return HTTP 2xx.

Request headers

HeaderValue
Content-Typeapplication/json
User-AgentScan.com-Webhook/1.0
X-Scan-Eventvisit.status_changed
Payload

JSON POST body sent to your webhook_url

string
enum
required

Webhook event identifier

Allowed:
string
required

Visit status after the change

changes
object
required

Fields that changed on this event

uuid
required

Visit that changed

date-time
required

When the status change was committed (ISO 8601)

referral
object
required

Referral snapshot (same shape as GET /api/v2/referrals/{id})

Response
200

Your endpoint acknowledged the event

Updated 3 months ago

Did this page help you?
LoadingLoading…

Updated 3 months ago

Did this page help you?