patient.config

When Signals sends patient.config, its payload and how to handle it in Node.js, Python and Java.

A patient's config is pushed. It is sent for every applied push, whatever it changed.

Payload

Every delivery is the envelope type, timestamp, sequence and data; the delivery's id is the webhook-id header. See Verify webhooks.

{
  "type": "patient.config",
  "timestamp": "2026-10-25T08:00:02.000Z",
  "sequence": 1056,
  "data": {
    "patient": "6f1c2a8e-3b7d-4c55-9a0e-2d4b8f6e1a90"
  }
}

It carries only the patient: read the config to see what changed.

Handle the event

Verify the delivery first (Verify webhooks), then act on the verified event as in Handle an event.

patient-config.js
export async function handle(webhookId, event) {
  if (!(await firstTime(webhookId))) return;
  const { data } = event;
  switch (event.type) {
    case 'patient.config':
      await refreshPatientConfig(data.patient);
      break;
    default:
      break;
  }
}

Last updated on

On this page