Docs

visit.approved

Preview· P9

A host, or someone acting for them, approves a visit. If the visitor is on site, visit.checked_in follows straight away; if they haven't arrived yet, the visit is expected again and pass.sent follows once their pass is sent.

Agoo sends this as a signed POST to every enabled endpoint subscribed to visit.approved (or *). Verify the signature, return any 2xx within 15 seconds, and de-duplicate on webhook-id.

Header Parameters

webhook-id*string

The event's ID. It is the same on every attempt and redelivery, so use it to de-duplicate.

Match^evt_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"evt_01m4ww0ezgf2bryg9gxb2gbewx"
webhook-timestamp*string

When this attempt was signed, in Unix seconds. Reject the request if it is more than 5 minutes from your clock.

Match^[0-9]+$
webhook-signature*string

One or more space-separated signatures, each v1,<base64>: the base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{raw body}, keyed with the base64-decoded part of your whsec_ secret. During a secret rotation there are two. Accept the request if any one matches.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

An event about a visit.

Response Body

Example Requests

POST/visit.approved