VXT

Connect Vxt

Connect VXT integration by validating + storing the user's refresh token.

Customer-facing — any admin user in the customer can connect.

post/vxt/connect

Request body

refresh_tokenstring required

Firebase refresh token obtained from app.vxt.co.nz

Response

Successful Response

connectedboolean required
statusstring nullable

connected | disconnected | error

connected_atstring nullable
vxt_emailstring nullable

Email of the VXT user whose refresh token is stored

last_successful_call_atstring nullable
last_error_msgstring nullable
webhook_urlstring nullable

Stable webhook URL to paste into VXT Settings → Webhooks (same for all customers)

webhook_tokenstring nullable

Per-customer bearer token. Customer pastes this into VXT as 'Bearer <token>' in the Authorization header of the webhook.

Changes

No recorded changes to this endpoint across all 1 revision of this API.