API reference
Webhook events
What NezerCare sends to your endpoints.
Events NezerCare sends to your endpoints. Add an endpoint in the dashboard under Integrations → Notifications; its signing secret is shown once. An endpoint is a POST address of your own: https on a public DNS name (not an IP address, localhost or a .local name), up to 10 for a workspace.
Verify x-nezer-signature against the raw request bytes before parsing JSON. Compute the lowercase hexadecimal HMAC-SHA256 of <x-nezer-timestamp>.<raw-body> (the timestamp is in seconds since the epoch) using the endpoint signing secret and compare it to the value after v1= using a constant-time comparison. Reject a timestamp more than five minutes from now, and deduplicate by x-nezer-event-id.
Delivery. Each request carries content-type: application/json, user-agent: NezerHealth-Webhooks/1.0 and the headers listed on each event. Answer with any 2xx within 5 seconds, once the event is stored durably: any other status, a redirect (NezerCare doesn't follow redirects), a connection failure or no answer in time fails the attempt. A failed delivery is retried after 2, 4, 8 … seconds, doubling up to about 17 minutes, and stops after 12 attempts (about 51 minutes after the first); a team member can send it again from the dashboard. Every retry reuses the event's x-nezer-event-id and is signed afresh, with a new timestamp. An address that gives no answer in time on 10 attempts in a row, over at least 10 minutes, is paused: nothing more is sent to it until someone in the dashboard presses Resume, and what waited is sent then. An endpoint can also be set to send an Authorization header (bearer or basic) or a header of your choosing with each request.
Workflow calls to your own systems (Destinations) are signed too, with your workspace's widget signing secret: x-nezer-signature is the HMAC-SHA256 of <x-nezer-timestamp>.<METHOD> <path and query>\n<raw body>. order_lookup.requested below is the order lookup contract an "Order status and tracking" workflow holds your order system to, and patient_search.requested is the patients_v1 call @Nezer makes to find who a group message in Slack is for, signed the same way.
The event catalog is the clinical-case events, the two portal conversation events, patient.deleted and two account events, billing.usage_threshold_reached and subscription.updated, sent to every endpoint subscribed to them. billing.usage_threshold_reached is sent once each as use reaches 80%, 95% and 100% of the month's credits, with unit: "credits", threshold, creditsUsed, monthlyCredits, remaining and paused (an older plan with a monthly active-patient limit sends unit: "active_patients", activePatients and activePatientLimit instead). Subscription updates carry status (trialing, active, past_due, grace_period, restricted, canceled or enterprise), plan, reason, recovered and invoicePastDue; grace expiry uses reason PAYMENT_GRACE_PERIOD_EXPIRED, and a paid invoice that follows a failed payment carries recovered: true (a first or ordinary monthly charge has false). An Enterprise subscription invoiced by NezerCare reports enterprise, with invoicePastDue: true while an invoice is overdue: the plan's own, or the invoice for a credit top-up (an update is sent when a top-up invoice becomes overdue, and when it's paid or voided after that). Clinical event bodies may contain protected health information and must not be written to ordinary logs.
Until the organization signs its BAA, every event that is about patients (the clinical-case events, the portal conversation events and patient.deleted) is held (not dropped, and no attempt is used) and goes out once it's signed. billing.usage_threshold_reached and subscription.updated are about your account and carry no patient data, so they're never held for the BAA.
order_lookup.requested
POSTto your endpoint
Sent by an active "Order status and tracking" workflow when a signed-in patient asks where their order is (English or Spanish), to your connection's address + the step's path (POST /orders/lookup in the template). Never sent for an anonymous visitor, a health question or an emergency, and never contains what the patient typed. One attempt; NezerCare waits up to 5 seconds (less if the connection says so). Answer 200 with an orders array, empty when there are none. Anything else (a status that isn't 2xx, a redirect, which isn't followed, no answer in time, or an answer that breaks the contract) makes the workflow say it couldn't check and offer the team; nothing is guessed.
Verify x-nezer-signature with your workspace's widget signing secret: the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<METHOD> <path and query>\n<raw body>, compared after v1= in constant time. Reject a timestamp more than five minutes from now.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-timestampRequired | header · string | Unix seconds.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1=<hex HMAC-SHA256 of timestamp + '.' + METHOD + ' ' + path and query + '\n' + raw body>, keyed with the widget signing secret.Matches ^v1=[a-f0-9]{64}$. |
x-nezer-test | header · string | Present on calls for a made-up test patient while NezerCare sets your workspace up (its test run). Don't change real orders or accounts for such a call; answer as you would in a test or sandbox.One of true. |
Payload
| Field | Type | Description |
|---|---|---|
versionRequired | integer | One of 1. |
typeRequired | string | One of order_lookup.requested. |
requestIdRequired | string | The workflow run's id; the same for every call in one run. |
patientRequired | object | |
patient.Required | string | Example: test-patient-1. |
{
"version": 1,
"type": "order_lookup.requested",
"requestId": "0f2c9a4e-3d7b-4c1e-9a55-000000000000",
"patient": {
"externalId": "test-patient-1"
}
}Your response
| Status | Meaning |
|---|---|
200 | The patient's orders (latest first, or with placedAt on each). At most three are shown. |
200 body
| Field | Type | Description |
|---|---|---|
ordersRequired | array of objects | Up to 50 items. |
orders[].Required | string | Your order number, as the patient knows it. A string (not a number).1–64 characters. |
orders[].Required | string | One of processing, shipped, delivered, delayed, cancelled. |
orders[]. | string or null | Shown instead of the widget's own word for the status, as written. An empty string makes the whole answer invalid: leave the field out, or send null, when there is none.1–80 characters. |
orders[]. | string or null | An empty string makes the whole answer invalid: leave the field out, or send null, when there is none.1–60 characters. |
orders[]. | string or null | Shown as a Track package link only when it's https (and has no user name or password); otherwise dropped.1–2000 characters. |
orders[]. | string or null | YYYY-MM-DD, or an ISO 8601 date-time with a time zone. |
orders[]. | string or null | YYYY-MM-DD or ISO 8601. When every order has it, the widget sorts latest first; otherwise it keeps your order. |
orders[]. | array of objects or null | Up to 20 items. |
orders[].Required | string | 1–120 characters. |
orders[].Required | integer | 1 to 999. |
{
"orders": [
{
"id": "TEST-1003",
"status": "shipped",
"statusLabel": "On its way",
"carrier": "UPS",
"trackingUrl": "https://www.ups.com/track?tracknum=1Z0000000000000000",
"estimatedDelivery": "2026-10-02",
"placedAt": "2026-09-25T15:04:00Z",
"items": [
{
"name": "Test Product A",
"quantity": 1
}
]
},
{
"id": "TEST-1001",
"status": "delivered",
"carrier": "USPS",
"placedAt": "2026-08-28T12:00:00Z"
}
]
}{
"orders": []
}patient_search.requested
POSTto your endpoint
Sent when a teammate asks @Nezer in your Slack channel to message a group of patients described in words ("everyone whose UPS order shipped from Dallas last week"), and to test a search from the staff app, to your connection's address + the search's path. It carries only the filters your search declares, as checked by NezerCare: choice values you set up, dates (YYYY-MM-DD), date ranges (both days included, at most 93 days, within 366 days back and 92 days ahead of today in the clinic's time zone) and codes. Never patient data, and never anything a teammate typed. One attempt per page; NezerCare waits up to 5 seconds, reads at most 4 pages, and stops once it has more than 50 different patients' IDs (one message's limit). Answer 200 with the patients' IDs. Anything else (a status that isn't 2xx, a redirect, which isn't followed, no answer in time, or an answer that breaks the contract) makes @Nezer say it couldn't search; nothing is sent to anyone.
Every call is signed: a search can't be tested or turned on until the workspace has a widget signing secret. Verify x-nezer-signature with that widget signing secret, exactly as for a workflow call: the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<METHOD> <path and query>\n<raw body>, compared after v1= in constant time. Reject a timestamp more than five minutes from now.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-timestampRequired | header · string | Unix seconds.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1=<hex HMAC-SHA256 of timestamp + '.' + METHOD + ' ' + path and query + '\n' + raw body>, keyed with the widget signing secret.Matches ^v1=[a-f0-9]{64}$. |
x-nezer-test | header · string | Present on a test from the staff app (and NezerCare setup's). Answer as you would for real: the test shows the counts and how many of your IDs are patients in Nezer.One of true. |
Payload
| Field | Type | Description |
|---|---|---|
versionRequired | integer | One of 1. |
typeRequired | string | One of patient_search.requested. |
requestIdRequired | string (uuid) | The same for every page of one search. |
searchKeyRequired | string | Which of your searches this is, as set up in the staff app.Matches ^[a-z][a-z0-9_]{1,39}$. |
filtersRequired | object | By filter key. A filter that isn't required may be absent. |
limitRequired | integer | Send at most this many patients per page.One of 50. |
cursorRequired | string or null | Your previous page's nextCursor; null for the first page.Up to 500 characters. |
{
"version": 1,
"type": "patient_search.requested",
"requestId": "0f2c9a4e-3d7b-4c1e-9a55-000000000000",
"searchKey": "orders_shipped",
"filters": {
"carrier": "ups",
"warehouse": "dallas",
"shippedOn": {
"from": "2026-09-28",
"to": "2026-10-04"
}
},
"limit": 50,
"cursor": null
}Your response
| Status | Meaning |
|---|---|
200 | The patients found: their IDs only, a total, and a cursor for the next page. |
200 body
| Field | Type | Description |
|---|---|---|
patientsRequired | array of objects | Up to 50 items. |
patients[].Required | string | The patient's ID in your system (their external patient ID), with no spaces.1–80 characters.Matches ^[\p{L}\p{N}][\p{L}\p{N}._:@+/#-]{0,79}$. |
totalRequired | integer | How many patients match in all, at least the number sent. When NezerCare stops before the last page it's the number shown: over 50, @Nezer asks the team to narrow the search. Once every page is read, NezerCare counts the distinct IDs instead, so a patient sent twice (one per order) counts once.0 to 1000000. |
nextCursor | string or null | Present when there's another page; NezerCare sends it back as cursor.Up to 500 characters. |
{
"patients": [
{
"id": "TEST-1001"
},
{
"id": "TEST-1002"
}
],
"total": 2,
"nextCursor": null
}{
"patients": [
{
"id": "TEST-1001"
}
],
"total": 63,
"nextCursor": "page-2"
}{
"patients": [],
"total": 0
}conversation.message_created
POSTto your endpoint
One message was added to a portal conversation: the patient's own, NezerCare's reply (an answer, a hand-off, a notice, an emergency notice) or the care team's.
Sent to the endpoint you subscribed in Integrations, Notifications, signed and retried like every other event (return 2xx after durable receipt; verify the raw-body signature and deduplicate by x-nezer-event-id and by the message's id). The body holds patient messages: keep it out of ordinary application logs. Until the organization has signed its BAA these wait, and go out once it signs.
Webhooks are for speed; the feed is the truth. Delivery is at least once, in parallel, with no promised order, and a delivery gives up after 12 attempts. Apply messages by sequence, not by arrival. When a message's sequence is more than one above the last you have, or when a conversation opens, read GET /v1/patients/{patientId}/conversations/{conversationId}/messages?afterSequence=<the last you have> and apply what it returns.
Internal notes, resolution notes and everything staff-only are never in an event. A patient's own messages and NezerCare's replies to them are sent too (tagged with causedByRequestId), so a second device or tab sees them: drop the ones you already have.
An `emergency` message must be shown at once, in full, in these words, like the one in the response of the call that caused it. The webhook is never the only way you hear of it: the response to the patient's call carries it first.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always conversation.message_created. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | string (uuid) | |
data.Required | string or null | Your own ID for the conversation, if you sent one. |
data.Required | string (uuid) | |
data.Required | string or null | Your own ID for the patient, as you sent it to identify. |
data.Required | integer | The message's position in the conversation. Apply messages by this, not by arrival.At least 1. |
data.Required | object | One message of a conversation. text is always the words to show; the rest depends on kind. |
data.Required | object | The conversation as it stands when the event is sent, which can be newer than the message. |
data.Required | string | One of open, closed. |
data.Required | object | |
data.Required | string | One of received, in_progress, replied, scheduled, closed. |
data.Required | string | |
data.Required | boolean | |
data.Required | integer | At least 1. |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
answerIdRequired | string (uuid) | |
sourcesRequired | array of objects | Where the answer came from. Show them. |
sources[].Required | string | |
sources[].Required | string (uri) or null | |
actionsRequired | array of objects | At most a Book button, with an https address on the clinic's site. Never a contact button for a signed-in patient. |
actions[].Required | string | One of book. |
actions[].Required | string (uri) | |
actions[]. | string | One of demo, appointment, consultation, call. |
choicesRequired | array of objects | The buttons under the answer: send the id as choiceId. |
choices[].Required | string | One of helpful, talk_to_team. |
choices[].Required | string |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
purposeRequired | string | One of safety_check, intake, team_chat, workflow. |
inputRequired | object | choice: pick one of choices. text: answer in words (up to maxLength). attachments: add photos with the attachments call, then press done (or skip). |
input.Required | string | One of choice, text, attachments. |
input. | integer | Example: 2000. |
input. | array of objects | |
input.Required | string | Send it as choiceId.One of helpful, talk_to_team, yes, no, unsure, send, send_now, done, skip. |
input.Required | string | The words on the button, in the message's language. |
choices | array of objects | Shortcuts beside the question: send_now ("Send to my care team now", for an urgent concern, at any point) or done and skip for photos. |
choices[].Required | string | Send it as choiceId.One of helpful, talk_to_team, yes, no, unsure, send, send_now, done, skip. |
choices[].Required | string | The words on the button, in the message's language. |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
statusRequired | string | One of ready, urgent. |
summaryRequired | string | |
choicesRequired | array of objects | |
choices[].Required | string | Send it as choiceId.One of helpful, talk_to_team, yes, no, unsure, send, send_now, done, skip. |
choices[].Required | string | The words on the button, in the message's language. |
inputRequired | object | |
input. | string | One of text. |
input. | integer | |
input. | string | Example: Need to change something?. |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
ordersRequired | array of objects | |
orders[].Required | string | |
orders[].Required | string | One of processing, shipped, delivered, delayed, cancelled. |
orders[]. | string or null | |
orders[]. | string or null | |
orders[]. | string (uri) or null | |
orders[]. | string or null | |
orders[]. | string or null | |
orders[].Required | array of objects | |
orders[].Required | string | |
orders[].Required | integer |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
emergencyRequired | object | |
emergency.Required | array of objects | The ways to call. Thoughts of self-harm add 988. |
emergency.Required | string | Example: Call 911. |
emergency.Required | string | Example: tel:911. |
emergency.Required | boolean | Whether it reached the care team (an emergency case, or the clinical conversation). false means NezerCare could not file it yet and keeps trying until it does; the notice is shown either way, in the same words. |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
handoffRequired | object | |
handoff.Required | string | Something the patient and the team can both quote.Matches ^NC-[0-9A-F]{8}$. |
handoff.Required | string | One of clinical, billing, scheduling, fulfillment, support. |
handoff.Required | string | One of routine, urgent. |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
noticeRequired | object | |
notice.Required | string | One of paused. |
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | For the patient's own message, the requestId they sent. |
sequenceRequired | integer | Position in the conversation: 1, 2, 3 with no gaps. Order by this.At least 1. |
kindRequired | string | One of text, answer, question, review, emergency, handoff, notice, orders, closed. |
fromRequired | object | |
from.Required | string | nezer is the assistant and NezerCare's fixed notices; care_team is a person on the clinic's team, or the clinic's own system posting a reply.One of patient, nezer, care_team, system. |
from.Required | string | The words to show: "You", "NezerCare", "Care team" (Spanish "Usted", "NezerCare", "Equipo médico"). Staff names are never sent. |
priorityRequired | string | One of normal, emergency. |
languageRequired | string | The language of text.One of en, es. |
textRequired | string | Always present: the words to show. A portal that renders nothing else can print text and stay correct. Never rewrite it. |
causedByRequestId | string (uuid) | The patient request this message answers, when it answers one. |
attachments | array of objects | On a patient's message: the files they listed with it, as metadata (never the contents). |
attachments[].Required | string (uuid) | |
attachments[].Required | string | |
attachments[].Required | string | One of image/jpeg, image/png, image/webp, image/heic, application/pdf. |
attachments[].Required | integer | |
createdAtRequired | string (date-time) | |
closedRequired | object | |
closed.Required | string | One of closed. |
{
"id": "5f0c1d7e-3a5b-4c6d-9e8f-0a1b2c3d4e5f",
"type": "conversation.message_created",
"createdAt": "2026-10-18T16:21:45.000Z",
"data": {
"conversationId": "4a1c8e90-2b7d-4f36-9c05-7d3e1a6b8f12",
"externalConversationId": "portal-thread-991",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"externalPatientId": "pt_48213",
"sequence": 3,
"message": {
"id": "e5f6a7b8-c9d0-4e1f-8a3b-4c5d6e7f8091",
"sequence": 3,
"kind": "text",
"from": {
"kind": "care_team",
"label": "Care team"
},
"priority": "normal",
"language": "en",
"text": "Please keep the spot clean and dry. A nurse will call you today.",
"createdAt": "2026-10-18T16:21:44.000Z"
},
"conversation": {
"status": "open",
"careStatus": {
"code": "replied",
"label": "New reply from your care team"
},
"showCall911": false,
"version": 7
}
}
}{
"id": "5f0c1d7e-3a5b-4c6d-9e8f-0a1b2c3d4e5f",
"type": "conversation.message_created",
"createdAt": "2026-10-18T16:21:45.000Z",
"data": {
"conversationId": "4a1c8e90-2b7d-4f36-9c05-7d3e1a6b8f12",
"externalConversationId": "portal-thread-991",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"externalPatientId": "pt_48213",
"sequence": 2,
"message": {
"id": "d4e5f6a7-b8c9-4d0e-9f2a-3b4c5d6e7f80",
"sequence": 2,
"kind": "emergency",
"from": {
"kind": "nezer",
"label": "NezerCare"
},
"priority": "emergency",
"language": "en",
"text": "Call 911 now. What you described can need emergency care. Do not wait for your care team to reply.",
"emergency": {
"lines": [
{
"label": "Call 911",
"tel": "tel:911"
}
],
"sentToCareTeam": true
},
"causedByRequestId": "9d1f7a52-3c6e-4b85-8f0a-5b2c1d7e9a30",
"createdAt": "2026-10-18T15:09:30.000Z"
},
"conversation": {
"status": "open",
"careStatus": {
"code": "received",
"label": "Received"
},
"showCall911": true,
"version": 7
}
}
}{
"id": "5f0c1d7e-3a5b-4c6d-9e8f-0a1b2c3d4e5f",
"type": "conversation.message_created",
"createdAt": "2026-10-18T16:21:45.000Z",
"data": {
"conversationId": "4a1c8e90-2b7d-4f36-9c05-7d3e1a6b8f12",
"externalConversationId": "portal-thread-991",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"externalPatientId": "pt_48213",
"sequence": 4,
"message": {
"id": "f6a7b8c9-d0e1-4f2a-9b4c-5d6e7f809102",
"sequence": 4,
"kind": "closed",
"from": {
"kind": "nezer",
"label": "NezerCare"
},
"priority": "normal",
"language": "en",
"text": "Closed",
"closed": {
"reason": "closed"
},
"createdAt": "2026-10-18T17:02:00.000Z"
},
"conversation": {
"status": "closed",
"careStatus": {
"code": "closed",
"label": "Closed"
},
"showCall911": false,
"version": 9
}
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
conversation.updated
POSTto your endpoint
A portal conversation's state changed with no message to carry the change: its status, careStatus (a teammate acknowledged the case: "Your care team is on it"), appointment (booked, moved or cancelled), showCall911 or what it is awaiting. The body is the conversation as GET /v1/patients/{patientId}/conversations/{conversationId} returns it, except that appointment has only scheduledFor: a webhook never carries the visit link. A change that comes with a message arrives in that message's conversation.message_created instead, though one can still follow a message's event right away with the same version (applying it again changes nothing). Compare conversation.version with the one you hold and keep the higher.
Sent to the endpoint you subscribed in Integrations, Notifications, signed and retried like every other event (return 2xx after durable receipt; verify the raw-body signature and deduplicate by x-nezer-event-id and by the message's id). The body holds patient messages: keep it out of ordinary application logs. Until the organization has signed its BAA these wait, and go out once it signs.
Webhooks are for speed; the feed is the truth. Delivery is at least once, in parallel, with no promised order, and a delivery gives up after 12 attempts. Apply messages by sequence, not by arrival. When a message's sequence is more than one above the last you have, or when a conversation opens, read GET /v1/patients/{patientId}/conversations/{conversationId}/messages?afterSequence=<the last you have> and apply what it returns.
Internal notes, resolution notes and everything staff-only are never in an event. A patient's own messages and NezerCare's replies to them are sent too (tagged with causedByRequestId), so a second device or tab sees them: drop the ones you already have.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always conversation.updated. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | string (uuid) | |
data.Required | string or null | Your own ID for the conversation, if you sent one. |
data.Required | string (uuid) | |
data.Required | string or null | Your own ID for the patient, as you sent it to identify. |
data.Required | object | |
data.Required | string (uuid) | |
data.Required | string (uuid) | |
data. | string or null | |
data.Required | string | One of portal_api. |
data.Required | string | One of open, closed. |
data.Required | object | Where the conversation stands, in the widget's own words only. |
data.Required | string | One of received, in_progress, replied, scheduled, closed. |
data.Required | string | Example: New reply from your care team. |
data.Required | object | The appointment of the case this conversation is linked to, for your portal to show its patient, or null. It is there from booking until an hour after the start, and not once the case is closed or the appointment cancelled. In a response it carries visitUrl, the link that opens the visit; a webhook's `appointment` never does: read the conversation for it. The link lets whoever has it join the visit: show it to this patient only, and don't log it or put it in a URL. How an appointment is booked is in the Clinical cases operation updateClinicalCase. |
data.Required | boolean | True while an emergency conversation is open: keep the 911 guidance in view. |
data.Required | object | A hint for the composer, never a lock: free text is always accepted. |
data.Required | string | What the latest message from NezerCare waits for: one of its buttons, words (with choices as shortcuts, if any), or photos (then done or skip).One of none, choice, text, attachments. |
data. | string (uuid) | |
data. | array of strings | |
data.Required | integer | At least 0. |
data.Required | integer | Increases whenever the conversation changes.At least 1. |
data.Required | string | One of en, es. |
data.Required | object | The exact approved 911 line to print at all times where a patient can write or read messages, and the ways to call. Use these words rather than your own. |
data.Required | string | One of en, es. |
data.Required | string | Example: If this is a medical emergency, call 911.. |
data.Required | array of objects | |
data.Required | string | Example: Call 911. |
data.Required | string | Example: tel:911. |
data.Required | string (date-time) | |
data.Required | string (date-time) |
| Field | Type | Description |
|---|---|---|
scheduledForRequired | string (date-time) | The start, in UTC (show it in the patient's own time zone). |
visitUrl | string (uri) or null | The link to join the visit; null for an appointment booked before links were required; absent in a webhook. |
{
"id": "5f0c1d7e-3a5b-4c6d-9e8f-0a1b2c3d4e5f",
"type": "conversation.updated",
"createdAt": "2026-10-18T16:21:45.000Z",
"data": {
"conversationId": "4a1c8e90-2b7d-4f36-9c05-7d3e1a6b8f12",
"externalConversationId": "portal-thread-991",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"externalPatientId": "pt_48213",
"conversation": {
"id": "4a1c8e90-2b7d-4f36-9c05-7d3e1a6b8f12",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"externalConversationId": "portal-thread-991",
"channel": "portal_api",
"status": "open",
"careStatus": {
"code": "in_progress",
"label": "Your care team is on it"
},
"appointment": null,
"showCall911": false,
"awaiting": {
"type": "none"
},
"lastSequence": 2,
"version": 4,
"language": "en",
"safety": {
"language": "en",
"emergencyLine": "If this is a medical emergency, call 911.",
"lines": [
{
"label": "Call 911",
"tel": "tel:911"
}
]
},
"createdAt": "2026-10-18T15:02:11.000Z",
"updatedAt": "2026-10-18T15:02:13.000Z"
}
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
clinical_case.opened
POSTto your endpoint
Return 2xx after durable receipt. Verify the raw-body signature and deduplicate by x-nezer-event-id before creating or associating a provider workflow. The handoff paths are the API's own paths and start with /api/v1/...; on https://api.nezercare.com call them without the /api (/v1/clinical-cases/{caseId}/updates). No API key is sent in the webhook. data.intake holds the questions NezerCare asked the patient and their answers, so your system gets them with the case (the escalation to a Destination carries the same). One emergency is one event: a further emergency from the same patient within 15 minutes of an unresolved emergency case is added to that case and arrives as clinical_case.patient_message_created, not as a second clinical_case.opened.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always clinical_case.opened. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | string (uuid) | |
data. | string (uuid) | The ID of the record the case was opened from. The name dates from check-ins, which NezerCare no longer sends; follow the case by caseId. |
data.Required | string (uuid) | |
data.Required | string | emergency when NezerCare's emergency rule, or one of your extra emergency phrases, matched what the patient wrote in the widget, including a reply in a case or conversation they already had (it opens a new emergency case for the patient, unless the patient already has an unresolved emergency case from the last 15 minutes: then the message is added to that case and delivered as clinical_case.patient_message_created, with no second clinical_case.opened). routine when the only red flags asked for a routine follow-up (for example, a medicine that isn't working). urgent also when a patient wrote about their health in a reply in a thread that isn't a health one (an order, a bill, a booking): nothing triaged it, so it is filed for urgent review, with their words as the case's first message. A staff_slack case is urgent, or emergency when the teammate's request used NezerCare's emergency words.One of emergency, urgent, routine. |
data. | string | Where the case came from: patient_concern, a concern a signed-in patient raised in the widget (or the emergency case opened for an emergency in a reply they sent in an existing thread, or the case opened for a health detail they wrote in a reply in an order, billing or booking thread, which never goes to your Slack), or staff_slack, a clinical request a teammate made of @Nezer in your Slack channel. A staff_slack case is raised by staff, not reported by the patient: patientNotes is empty and the teammate's words stay in NezerCare as an internal note on the case.One of patient_concern, staff_slack. |
data. | string or null | What the patient wrote. Empty for a staff_slack case. |
data. | object | Always {}. Kept so receivers written when NezerCare sent check-ins keep working. |
data. | array of strings | Every red flag that matched, not only the worst: ai_intake:<concern key> for the Health concern the patient's words matched, deterministic_safety:<rule> when one of NezerCare's own safety rules matched them, health_concerns_phrase when one of the extra emergency phrases on your Health concerns matched (the rule names no phrase and holds no patient text), configured_safety_question when an answer to one of your safety questions asked for an urgent review, emergency_terms:<kind> for NezerCare's emergency words in a teammate's request, and staff_request:slack on every case raised from Slack. |
data. | object or null | For a concern the patient raised in the widget: the version of your workspace's Health concerns it was triaged on. Version 0 is the NezerCare defaults, which run until a clinician on your team approves your own. null otherwise. |
data. | integer | At least 0. |
data. | string | |
data. | string | The case's status when the event was built: open for a new case. Your processed and other updates don't change it; only a team member acknowledging or resolving it in NezerCare, or a resolved update, does.One of open, acknowledged, resolved. |
data. | string or null | Null until the case is resolved. |
data. | string or null | Null until the case is resolved. |
data. | string | What the triage decided, in the older vocabulary: emergency, clinical_escalation or self_care. priority is the field to read.One of emergency, clinical_escalation, self_care. |
data. | string (date-time) | When the concern the case was opened from was recorded. |
data. | object | The intake the patient went through before their concern became a case: the questions NezerCare asked and the patient's answers, in the order they were asked, so your system has what the care team sees in the conversation. Only what the patient saw and replied to: the words of your approved questions and safety checks as they read them, and what they sent back. Never the guide's summary or notes, the care team's messages or internal notes, another conversation, or anything after the case opened: a retry or a later event sends the same intake. For an emergency it holds what was asked before the emergency, if anything. It can hold protected health information: keep it out of ordinary logs. A case with no intake behind it (one a teammate raised from Slack, or one opened before October 24, 2026) has language: null and no questions. |
data.Required | string or null | The language of the questions and answers: the language the patient used the widget in. null when NezerCare has no record of an intake for the case.One of en, es, null. |
data.Required | array of objects | Up to 50 items. |
data.Required | string | follow_up: one of your concern type's approved questions, or the closing "anything else" line. safety: one of its safety checks, a question with Yes, No and Not sure buttons.One of follow_up, safety. |
data.Required | string | The question as the patient read it, in their language.Up to 600 characters. |
data.Required | string or null | What the patient replied, as they sent it: the button's label on a safety check ("Yes", "No", "Sí"), or their own words. null when the case was sent before they answered this question (they sent it early, or NezerCare filed an urgent case for them after ten minutes without a reply). An answer longer than 1,000 characters is cut and ends with … [truncated]; the whole reply stays in the case's conversation in NezerCare.Up to 1000 characters. |
data. | string | Only on a safety check the patient answered with its Yes, No or Not sure button: which one, whatever the language. Left out when they typed an answer instead.One of yes, no, unsure. |
data.Required | integer | How many questions beyond the first 50 were left out. 0 in practice: an intake asks far fewer.At least 0. |
data.Required | object | Where to report back. The paths are the API's own and start with /api/v1/...: on https://api.nezercare.com call them without the /api. No API key is in the webhook. |
data. | string (uuid) | |
data. | string | GET: read the case's progress. |
data. | string | POST: report progress. |
data. | string | POST: write to the patient. |
data. | string | The first update must have this status.Always processed. |
data. | integer | The first update must have this sequence.Always 1. |
data. | boolean | Always false: a 2xx answer to this event confirms transport only.Always false. |
{
"id": "5f0c1d7e-3a5b-4c6d-9e8f-0a1b2c3d4e5f",
"type": "clinical_case.opened",
"createdAt": "2026-10-11T14:05:00.000Z",
"data": {
"caseId": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
"checkInId": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"priority": "urgent",
"status": "open",
"resolutionOutcome": null,
"resolutionNote": null,
"disposition": "clinical_escalation",
"source": "patient_concern",
"patientNotes": "Injection site reaction\n\nThere's a reddish spot where I injected and it's spreading.",
"intake": {
"language": "en",
"questions": [
{
"kind": "safety",
"question": "Is the redness spreading quickly, or do you have a fever?",
"answer": "No",
"choice": "no"
},
{
"kind": "follow_up",
"question": "When did you first notice it?",
"answer": "Two days ago, the evening after my Sunday dose."
},
{
"kind": "follow_up",
"question": "Is it getting better, worse or staying the same?",
"answer": "Worse. It's about the size of a coin now and warm to the touch."
}
],
"omittedQuestions": 0
},
"symptomScores": {},
"matchedRules": [
"ai_intake:injection_site_reaction"
],
"healthConcerns": {
"version": 3,
"label": "Health concerns v3"
},
"submittedAt": "2026-10-11T14:05:00.000Z",
"handoff": {
"caseId": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
"updatesPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/updates",
"progressPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/progress",
"messagesPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/messages",
"firstStatus": "processed",
"firstSequence": 1,
"transportReceiptIsClinicalAcceptance": false
}
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
Escalation to a Destination
POSTto your endpoint
The other way a case reaches your system. When a concern type in your Health concerns has a Destination ("Also send to"), NezerCare also sends each case of that type, as it opens, to that Destination's address: a POST of the JSON below, authenticated with the credentials you set on the Destination (a bearer token, basic credentials or your API-key header; with "API key in request body" your key is instead an extra top-level apiKey field of the JSON, never a header). It is not signed: there is no x-nezer-signature or timestamp, and the Destination's own credentials are what it proves itself with. caseId and handoff are how your system reports back on the case, as for clinical_case.opened; intake is the same as there. Verify the credentials you set, deduplicate on the Idempotency-Key (the case's submission ID, checkInId: a retry sends the same payload with the same key) and return 2xx after durable receipt. A 2xx is a receipt only, never a clinician's acceptance. A network error, a timeout, 408, 429 or 5xx is retried, up to eight attempts with a wait that doubles up to an hour; any other answer fails the send, and redirects are not followed. It can hold protected health information: keep it out of ordinary logs. A test patient's case is never sent.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
Idempotency-KeyRequired | header · string (uuid) | The case's submission ID, the same as checkInId. A retry reuses it: deduplicate on it. |
X-Nezer-Submission-IdRequired | header · string (uuid) | NezerCare's ID for this send. The same on every attempt. |
Payload
| Field | Type | Description |
|---|---|---|
patientIdRequired | string (uuid) | |
checkInIdRequired | string (uuid) | The submission's ID, the same as the Idempotency-Key. The name dates from check-ins; follow the case by caseId. |
caseId | string (uuid) | The case's own ID, for the calls below. Absent from an escalation queued before October 24, 2026. |
dispositionRequired | string | The older vocabulary; priority is the field to read.One of emergency, clinical_escalation, self_care. |
matchedRulesRequired | array of strings | Every red flag that matched, as on clinical_case.opened. |
notesRequired | string | What the patient wrote: the concern type's name, a blank line and their first message. The same as patientNotes on clinical_case.opened. |
intake | object | The intake the patient went through before their concern became a case: the questions NezerCare asked and the patient's answers, in the order they were asked, so your system has what the care team sees in the conversation. Only what the patient saw and replied to: the words of your approved questions and safety checks as they read them, and what they sent back. Never the guide's summary or notes, the care team's messages or internal notes, another conversation, or anything after the case opened: a retry or a later event sends the same intake. For an emergency it holds what was asked before the emergency, if anything. It can hold protected health information: keep it out of ordinary logs. A case with no intake behind it (one a teammate raised from Slack, or one opened before October 24, 2026) has language: null and no questions. |
intake.Required | string or null | The language of the questions and answers: the language the patient used the widget in. null when NezerCare has no record of an intake for the case.One of en, es, null. |
intake.Required | array of objects | Up to 50 items. |
intake.Required | string | follow_up: one of your concern type's approved questions, or the closing "anything else" line. safety: one of its safety checks, a question with Yes, No and Not sure buttons.One of follow_up, safety. |
intake.Required | string | The question as the patient read it, in their language.Up to 600 characters. |
intake.Required | string or null | What the patient replied, as they sent it: the button's label on a safety check ("Yes", "No", "Sí"), or their own words. null when the case was sent before they answered this question (they sent it early, or NezerCare filed an urgent case for them after ten minutes without a reply). An answer longer than 1,000 characters is cut and ends with … [truncated]; the whole reply stays in the case's conversation in NezerCare.Up to 1000 characters. |
intake. | string | Only on a safety check the patient answered with its Yes, No or Not sure button: which one, whatever the language. Left out when they typed an answer instead.One of yes, no, unsure. |
intake.Required | integer | How many questions beyond the first 50 were left out. 0 in practice: an intake asks far fewer.At least 0. |
priorityRequired | string | One of emergency, urgent, routine. |
handoff | object | Where to report back. The paths are the API's own and start with /api/v1/...: on https://api.nezercare.com call them without the /api. No API key is in the webhook. |
handoff. | string (uuid) | |
handoff. | string | GET: read the case's progress. |
handoff. | string | POST: report progress. |
handoff. | string | POST: write to the patient. |
handoff. | string | The first update must have this status.Always processed. |
handoff. | integer | The first update must have this sequence.Always 1. |
handoff. | boolean | Always false: a 2xx answer to this event confirms transport only.Always false. |
apiKey | string | Only when the Destination's authentication is "API key in request body": the key you saved on the Destination, added to every send (and retry) as this top-level field in place of a header. Absent for every other authentication. It is your own credential: verify it and keep it out of ordinary logs. |
{
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"checkInId": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
"caseId": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
"disposition": "clinical_escalation",
"matchedRules": [
"ai_intake:injection_site_reaction"
],
"notes": "Injection site reaction\n\nThere's a reddish spot where I injected and it's spreading.",
"intake": {
"language": "en",
"questions": [
{
"kind": "safety",
"question": "Is the redness spreading quickly, or do you have a fever?",
"answer": "No",
"choice": "no"
},
{
"kind": "follow_up",
"question": "When did you first notice it?",
"answer": "Two days ago, the evening after my Sunday dose."
},
{
"kind": "follow_up",
"question": "Is it getting better, worse or staying the same?",
"answer": "Worse. It's about the size of a coin now and warm to the touch."
}
],
"omittedQuestions": 0
},
"priority": "urgent",
"handoff": {
"caseId": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
"updatesPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/updates",
"progressPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/progress",
"messagesPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/messages",
"firstStatus": "processed",
"firstSequence": 1,
"transportReceiptIsClinicalAcceptance": false
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; the retries above follow anything else. |
clinical_case.patient_message_created
POSTto your endpoint
Contains patient-authored clinical content. Verify, deduplicate, and route it without placing the body in ordinary application logs. It is also how a patient's further emergency message arrives: within 15 minutes of an unresolved emergency case for the same patient it is added to that case, with this event on that case's caseId and no second clinical_case.opened. Do not treat it as a new emergency case.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always clinical_case.patient_message_created. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | string (uuid) | |
data.Required | string (uuid) | |
data.Required | string (uuid) | |
data. | string | Always patient. |
data.Required | string | |
data.Required | string (date-time) | |
data. | string | POST: where to answer, the case's messages path (/api/v1/clinical-cases/{caseId}/messages; leave the /api off on https://api.nezercare.com). |
{
"id": "ec6bf514-a01d-4406-8b76-6b1bb841617a",
"type": "clinical_case.patient_message_created",
"createdAt": "2026-10-21T04:34:54.527Z",
"data": {
"caseId": "8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d",
"messageId": "154d8b33-fb89-494f-b61b-705dc800dbcc",
"patientId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
"sender": "patient",
"message": "The redness has spread since this morning.",
"sentAt": "2026-10-21T04:34:54.527Z",
"replyPath": "/api/v1/clinical-cases/8a7b6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d/messages"
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
clinical_case.acknowledged
POSTto your endpoint
Sent when a team member acknowledges the case in NezerCare. It isn't the same as your processed case update. The body is the same as clinical_case.opened, with the case's status.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | One of clinical_case.acknowledged, clinical_case.resolved. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | The same body as clinical_case.opened (patient notes, the intake's questions and answers, matched rules, handoff and the rest), with the case's status now. It can hold protected health information. |
data.Required | string (uuid) | |
data.Required | string (uuid) | |
data.Required | string | The case's status when the event was built: normally acknowledged for clinical_case.acknowledged and resolved for clinical_case.resolved, but a late delivery shows where the case is by then.One of open, acknowledged, resolved. |
data. | string or null | Set on clinical_case.resolved; null otherwise. |
data. | string or null | The team member's note, set on clinical_case.resolved; null otherwise. |
Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
clinical_case.resolved
POSTto your endpoint
Sent when a team member resolves the case in NezerCare. A resolution your own system reports with a resolved case update does not send it (you already know). The body is the same as clinical_case.opened, with the case's status and its resolutionOutcome and resolutionNote. A late delivery can describe a case your integration has already processed; deduplicate by event ID.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | One of clinical_case.acknowledged, clinical_case.resolved. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | The same body as clinical_case.opened (patient notes, the intake's questions and answers, matched rules, handoff and the rest), with the case's status now. It can hold protected health information. |
data.Required | string (uuid) | |
data.Required | string (uuid) | |
data.Required | string | The case's status when the event was built: normally acknowledged for clinical_case.acknowledged and resolved for clinical_case.resolved, but a late delivery shows where the case is by then.One of open, acknowledged, resolved. |
data. | string or null | Set on clinical_case.resolved; null otherwise. |
data. | string or null | The team member's note, set on clinical_case.resolved; null otherwise. |
Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
patient.deleted
POSTto your endpoint
Emitted when the clinic deletes a patient's data in NezerCare (an owner or administrator, from the patient's page). Carries no health information: the patient's ID, the workspace ID (environmentId), a reason code and the time. Delete or close your copy of the record as your own policy requires; the patient's earlier events refer to IDs that no longer exist in NezerCare.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always patient.deleted. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | string (uuid) | |
data.Required | string (uuid) | |
data. | string or null | One of patient_request, duplicate_record, entered_in_error, test_record, clinic_policy, null. |
data.Required | string (date-time) |
{
"id": "9b1f2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
"type": "patient.deleted",
"createdAt": "2026-10-01T15:04:05.000Z",
"data": {
"patientId": "6cb4ccfc-2f1e-4d3a-9b8c-7d6e5f4a3b2c",
"environmentId": "1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"reason": "patient_request",
"deletedAt": "2026-10-01T15:04:05.000Z"
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
billing.usage_threshold_reached
POSTto your endpoint
An account event: use reached 80%, 95% or 100% of the month's credits, sent once each per month. No patient data, and never held for the BAA. An organization still on an older plan with a monthly active-patient limit gets it at 80% and 100% of that limit, with unit: "active_patients".
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always billing.usage_threshold_reached. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object |
data with unit credits
| Field | Type | Description |
|---|---|---|
unitRequired | string | Always credits. |
thresholdRequired | integer | One of 80, 95, 100. |
creditsUsedRequired | integer | |
monthlyCreditsRequired | integer | |
remainingRequired | integer | Credits left, top-ups included. |
pausedRequired | boolean | Whether Nezer's work that uses credits is paused when the event is sent. |
data with unit active_patients
| Field | Type | Description |
|---|---|---|
unitRequired | string | Always active_patients. |
thresholdRequired | integer | One of 80, 100. |
activePatientsRequired | integer | |
activePatientLimitRequired | integer |
{
"id": "3f6c1b2a-8d4e-4f5a-9b6c-7d8e9f0a1b2c",
"type": "billing.usage_threshold_reached",
"createdAt": "2026-10-01T15:04:05.000Z",
"data": {
"unit": "credits",
"threshold": 80,
"creditsUsed": 2400,
"monthlyCredits": 3000,
"remaining": 600,
"paused": false
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
subscription.updated
POSTto your endpoint
An account event: your subscription changed state (a payment, a failed payment, grace-period expiry, a cancellation, a first payment, or an Enterprise invoice paid or overdue). No patient data, and never held for the BAA.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always subscription.updated. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | string | One of trialing, active, past_due, grace_period, restricted, canceled, enterprise. |
data.Required | string or null | The plan's code (for example starter, practice, growth or enterprise), or null when the change doesn't say. |
data.Required | string or null | One of PAYMENT_GRACE_PERIOD_EXPIRED, null. |
data.Required | boolean | True only for a paid invoice that follows a failed payment. |
data.Required | boolean | True while an Enterprise invoice is overdue: the plan's own or a credit top-up's. |
{
"id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
"type": "subscription.updated",
"createdAt": "2026-10-01T15:04:05.000Z",
"data": {
"status": "restricted",
"plan": null,
"reason": "PAYMENT_GRACE_PERIOD_EXPIRED",
"recovered": false,
"invoicePastDue": false
}
}Your response
| Status | Meaning |
|---|---|
200 | Durably received. Any 2xx status counts; anything else is retried. |
integration.test
POSTto your endpoint
Sent only when someone on your team presses Test connection beside your address in Integrations → Connection health. You can't subscribe to it. It is built and signed exactly like a real event: the same headers, the signature from this address's own signing secret, and the address's login (an Authorization or API-key header) when it has one, so a receiver that verifies the signature or the login sees what a delivery would show it. It says it is a test (data.test is true and the x-nezer-test header is true), carries no patient data and creates nothing in NezerCare. Answer with any 2xx and do nothing else with it; a 401 means your receiver didn't accept the signature or the login. It is sent once, never retried, to the public address only, and a redirect is not followed. Your team sees the answer's status in Connection health.
Signed by NezerCare. Check x-nezer-signature before you trust the body: Verify webhooks.
Headers
| Field | Type | Description |
|---|---|---|
x-nezer-event-idRequired | header · string (uuid) | The event's ID, the same as the body's id. A retry of the delivery reuses it: deduplicate on it. |
x-nezer-event-typeRequired | header · string | The event's name, such as clinical_case.opened. |
x-nezer-timestampRequired | header · string | When this attempt was signed, in seconds since the epoch. A retry is signed afresh.Matches ^[0-9]+$. |
x-nezer-signatureRequired | header · string | v1= and the lowercase hex HMAC-SHA256 of <x-nezer-timestamp>.<raw request body>, keyed with the endpoint's signing secret.Matches ^v1=[a-f0-9]{64}$. |
idempotency-keyRequired | header · string (uuid) | The same value as x-nezer-event-id. |
x-nezer-testRequired | header · string | Always true on this event, so a receiver can tell a test from a delivery.Always true. |
Payload
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | The event's ID, the same as the x-nezer-event-id header. Deduplicate on it. |
typeRequired | string | Always integration.test. |
createdAtRequired | string (date-time) | When NezerCare queued this delivery to your endpoint. |
dataRequired | object | |
data.Required | boolean | Always true. |
data.Required | string (uuid) | This test's own ID, the same as the body's id and x-nezer-event-id. |
data.Required | string (uuid) | |
data.Required | string (date-time) | |
data.Required | string |
{
"id": "0c9f6a41-2b7d-4e58-9a13-6f8d2c4b7e10",
"type": "integration.test",
"createdAt": "2026-10-24T14:05:00.000Z",
"data": {
"test": true,
"probeId": "0c9f6a41-2b7d-4e58-9a13-6f8d2c4b7e10",
"environmentId": "1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"sentAt": "2026-10-24T14:05:00.000Z",
"message": "This is a test from NezerCare's Test connection. It carries no patient data. Answer with any 2xx and do nothing else with it."
}
}Your response
| Status | Meaning |
|---|---|
200 | Any 2xx status counts as reachable. Anything else is shown to your team as the answer your system gave. |