Event types
A webhook configuration (POST /v2/webhooks) has exactly one source
and one or more event types. Zentake delivers a separate event for
every (source, event_type) combination that occurs and matches an active
configuration.
Sources
source | Resource | Corresponding retrieve schema |
|---|---|---|
patient | Patient | GET /v2/patients/{id} |
document | PDF Document template | GET /v2/documents/{id} |
form | Form | GET /v2/forms/{id} |
packet | Packet | GET /v2/packets/{id} |
response | Response | GET /v2/responses/{id} |
packet_response | Packet Response | No public retrieve endpoint, schema is the PacketResponseSerializer shape shown in Webhook payloads |
Event types
event_type | Meaning |
|---|---|
created | A new record of the given source was created, e.g. a new Patient, or a new Response created when a Patient opens a Form. |
updated | An existing record changed, e.g. a Response's answers changed, or a Packet Response's form_index advanced or is_submitted flipped to true. |
deleted | A record was deleted. |
There's no dedicated "completed" event type. A Form or Packet being
finished shows up as an updated event on response or
packet_response where the payload's is_submitted is now true, see
Receive completion webhooks
for how to distinguish that from other updated events.
What you can subscribe to
Each webhook configuration you create picks one source and any
subset of the three event_type values (POST /v2/webhooks,
event_types: ["created", "updated"] for example). To watch multiple
sources, create multiple webhook configurations, see
Create a new webhook configuration and
Retrieve a list of webhook configurations.