A request was acknowledged

From the staff console, the companion app or the API.

Header Parameters

webhook-id*string

The message id: identical on every retry and redelivery. Deduplicate on it.

webhook-signature*string

Space-separated v1,<base64 HMAC-SHA256> signatures (two during a rotation).

webhook-timestamp*string

Unix seconds. Reject values more than 5 minutes away.

Match^\d{1,12}$

application/json

TypeScript Definitions

Use the request body type in TypeScript.

apiVersion*string

data*

A structured request a patient sent to the care team. Never contains free text.

environment*string

Value in

expiresAt*UtcTimestamp

RFC 3339 UTC timestamp with milliseconds.

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

Formatdate-time

id*string

Match^msg_[0-9A-Za-z]{10,64}$

site*|null

timestamp*UtcTimestamp

RFC 3339 UTC timestamp with milliseconds.

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

Formatdate-time

type*string

Example Requests

POST/request.acknowledged