Skip to main content
Every message has the same envelope. Pick the format per endpoint.

Nested (default)

Flat

Every field at the top level — easiest for low-code tools such as GoHighLevel. event carries the event’s flat name (see Events); an event with no flat name (such as webhook.disabled) uses its event type there instead.

Fields

By default payloads carry IDs, account contact details and event metadata only — never call transcripts, caller details, recordings or PBX credentials.

Call event example

Nested
In the flat format phi stays one nested object, so a low-code tool can map it once:
Flat

Survey event example

A survey.completed message from a CSAT survey where the caller rated the representative 4. The second question was not shown, so it is not in answers. phi carries what the organization allows: here Webhook PHI is on and redaction is off, so the caller’s number and the raw answer text are in phi, and open_answers is left out because no open question was answered.
Nested

PHI (protected health information)

Caller details and call content are sent only when the organization opts in, with the organization setting Webhook PHI (org.webhook_phi). Only an admin can change it, from the organization’s settings in the dashboard: an account admin, or a Reseller Admin of its reseller. It cannot be set with an API key or the settings API. Every change is audited. The setting in force when the event happened decides; changing it later does not change events already recorded. Healthcare (secure access) organizations can opt in too. A field is left out when it has no value. The call transcript is never sent: open transcript_url to read it. Never sent at any setting: recordings or audio, PBX credentials, API key or webhook secrets. Stored event data, phi included, is deleted with the delivery logs, after the retention period Telzino sets for the platform (30 days by default).