--- openapi: 3.1.0 info: title: API V2 Webhooks version: v2 description: |- Outbound webhook deliveries for the Canonical Data Model. Subscribe an endpoint to a `canonical.v0..*` family (or an exact event name) in Settings → Connect → Webhooks. This document is generated from the live ApplicationEvent producers and CDM-derived record schemas. ## Verifying a delivery `Wawa-Signature` carries a unix timestamp and one HMAC-SHA256 digest per currently accepted signing secret: ``` Wawa-Signature: t=,v1=[,v1=] digest = lowercase_hex(HMAC_SHA256(signing_secret, ".")) ``` 1. Hash the raw request bytes, before any JSON parsing. Re-serialising the body changes the digest. 2. Compare with a constant-time comparison, not a plain equality check. 3. Accept the delivery when your secret matches **any** `v1` entry. Every delivery is signed once per accepted secret, so there are two during the 24-hour rotation overlap; a parser that keeps only the last entry starts rejecting valid deliveries the moment a secret is rotated. 4. Reject timestamps outside a tolerance you choose, to bound replay. Only trust the body once it verifies, then deduplicate on `Wawa-Event-Id`, which repeats across retries and manual resends. ## Serving several accounts on one URL One URL can receive deliveries from several wawa accounts. Each endpoint has its own signing secret, so look the secret up by `Wawa-Endpoint-Id` before verifying, and take the verified endpoint as the account identity. Record ids and `sequence` are per account, so key stored records and ordering state by endpoint id as well as record id. servers: - url: "{defaultHost}" variables: defaultHost: default: https://clinic.wawafertility.com components: schemas: WebhookEnvelope: type: object required: - id - type - sequence - occurred_at - originating_request_id - data properties: id: type: string format: uuid type: type: string sequence: type: integer occurred_at: type: string format: date-time originating_request_id: type: - string - 'null' data: type: object required: - record properties: record: type: object PatientRecord: title: canonical.v0.patient record description: The data.record payload of every canonical.v0.patient.* webhook — the resource's current CDM state (as_cdm_json). Generated from the vendored CDM DDL; additionalProperties allows view-only columns. type: object required: - id properties: id: type: integer first_name: type: - string - 'null' last_name: type: - string - 'null' title: type: - string - 'null' patient_identity_management_id: type: - string - 'null' middle_name: type: - string - 'null' preferred_name: type: - string - 'null' full_legal_name: type: - string - 'null' date_of_birth: type: - string - 'null' format: date email: type: - string - 'null' sex_assigned_at_birth: type: - string - 'null' gender_identity: type: - string - 'null' pronouns: type: - string - 'null' ethnicity: type: - string - 'null' fathers_ethnicity: type: - string - 'null' mothers_ethnicity: type: - string - 'null' country_of_birth: type: - string - 'null' town_or_city_of_birth: type: - string - 'null' preferred_language: type: - string - 'null' marital_status: type: - string - 'null' blood_group: type: - string - 'null' rhesus_factor: type: - string - 'null' address_line_1: type: - string - 'null' address_line_2: type: - string - 'null' town_or_city: type: - string - 'null' state_or_province: type: - string - 'null' postcode: type: - string - 'null' country: type: - string - 'null' is_donor: type: - boolean - 'null' is_deceased: type: - boolean - 'null' primary_user_id: type: - integer - 'null' brand_id: type: - integer - 'null' fund_source_id: type: - integer - 'null' metadata: type: - object - 'null' initial_contact_at: type: - string - 'null' format: date-time first_seen_at: type: - string - 'null' format: date-time source_system: type: - string - 'null' deleted: type: - string - 'null' format: date-time created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time external_identifier: type: - string - 'null' PatientExternalIdentifierRecord: title: canonical.v0.patient_external_identifier record description: The data.record payload of every canonical.v0.patient_external_identifier.* webhook — the resource's current CDM state (as_cdm_json). Generated from the vendored CDM DDL; additionalProperties allows view-only columns. type: object required: - id properties: id: type: integer patient_id: type: - integer - 'null' identifier_type: type: - string - 'null' identifier_value: type: - string - 'null' issuing_jurisdiction: type: - string - 'null' valid_from: type: - string - 'null' format: date valid_to: type: - string - 'null' format: date source_system: type: - string - 'null' deleted: type: - string - 'null' format: date-time created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time primary: type: boolean description: Whether this is the patient's primary identifier. PatientPhoneRecord: title: canonical.v0.patient_phone record description: The data.record payload of every canonical.v0.patient_phone.* webhook — the resource's current CDM state (as_cdm_json). Generated from the vendored CDM DDL; additionalProperties allows view-only columns. type: object required: - id properties: id: type: integer patient_id: type: - integer - 'null' phone_type: type: - string - 'null' phone_number: type: - string - 'null' country_code: type: - string - 'null' preferred_at: type: - string - 'null' format: date-time source_system: type: - string - 'null' deleted: type: - string - 'null' format: date-time created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time PatientRelationshipRecord: title: canonical.v0.patient_relationship record description: The data.record payload of every canonical.v0.patient_relationship.* webhook — the resource's current CDM state (as_cdm_json). Generated from the vendored CDM DDL; additionalProperties allows view-only columns. type: object required: - id properties: id: type: integer patient_id: type: - integer - 'null' related_patient_id: type: - integer - 'null' relationship_type: type: - string - 'null' same_sex_couple: type: - boolean - 'null' active_from: type: - string - 'null' format: date active_to: type: - string - 'null' format: date source_system: type: - string - 'null' deleted: type: - string - 'null' format: date-time created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time SchedulerEventRecord: title: canonical.v0.scheduler_event record description: The data.record payload of every canonical.v0.scheduler_event.* webhook — the resource's current CDM state (as_cdm_json). Generated from the vendored CDM DDL; additionalProperties allows view-only columns. type: object required: - id properties: id: type: integer patient_id: type: - integer - 'null' scheduler_event_type_id: type: - integer - 'null' event_type: type: - string - 'null' title: type: - string - 'null' start_at: type: - string - 'null' format: date-time end_at: type: - string - 'null' format: date-time all_day: type: - boolean - 'null' status: type: - string - 'null' appointment_status: type: - string - 'null' scheduler_event_status_id: type: - integer - 'null' location_id: type: - integer - 'null' meeting_type: type: - string - 'null' notes: type: - string - 'null' internal_notes: type: - string - 'null' source_system: type: - string - 'null' deleted: type: - string - 'null' format: date-time created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time external_identifier: type: - string - 'null' webhooks: canonical.v0.patient.created: post: operationId: canonical_v0_patient_created summary: canonical.v0.patient.created description: Delivered when a `canonical.v0.patient.created` event is published. Subscribe via the `canonical.v0.patient.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient.created data: type: object properties: record: "$ref": "#/components/schemas/PatientRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient.created sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 first_name: example last_name: example title: example patient_identity_management_id: example middle_name: example preferred_name: example full_legal_name: example date_of_birth: '2026-07-01' email: example sex_assigned_at_birth: example gender_identity: example pronouns: example ethnicity: example fathers_ethnicity: example mothers_ethnicity: example country_of_birth: example town_or_city_of_birth: example preferred_language: example marital_status: example blood_group: example rhesus_factor: example address_line_1: example address_line_2: example town_or_city: example state_or_province: example postcode: example country: example is_donor: true is_deceased: true primary_user_id: 1 brand_id: 1 fund_source_id: 1 metadata: {} initial_contact_at: '2026-07-01T09:00:00.000000Z' first_seen_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient.demographics_updated: post: operationId: canonical_v0_patient_demographics_updated summary: canonical.v0.patient.demographics_updated description: Delivered when a `canonical.v0.patient.demographics_updated` event is published. Subscribe via the `canonical.v0.patient.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient.demographics_updated data: type: object properties: record: "$ref": "#/components/schemas/PatientRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient.demographics_updated sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 first_name: example last_name: example title: example patient_identity_management_id: example middle_name: example preferred_name: example full_legal_name: example date_of_birth: '2026-07-01' email: example sex_assigned_at_birth: example gender_identity: example pronouns: example ethnicity: example fathers_ethnicity: example mothers_ethnicity: example country_of_birth: example town_or_city_of_birth: example preferred_language: example marital_status: example blood_group: example rhesus_factor: example address_line_1: example address_line_2: example town_or_city: example state_or_province: example postcode: example country: example is_donor: true is_deceased: true primary_user_id: 1 brand_id: 1 fund_source_id: 1 metadata: {} initial_contact_at: '2026-07-01T09:00:00.000000Z' first_seen_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient.fund_source_changed: post: operationId: canonical_v0_patient_fund_source_changed summary: canonical.v0.patient.fund_source_changed description: Delivered when a `canonical.v0.patient.fund_source_changed` event is published. Subscribe via the `canonical.v0.patient.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient.fund_source_changed data: type: object properties: record: "$ref": "#/components/schemas/PatientRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient.fund_source_changed sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 first_name: example last_name: example title: example patient_identity_management_id: example middle_name: example preferred_name: example full_legal_name: example date_of_birth: '2026-07-01' email: example sex_assigned_at_birth: example gender_identity: example pronouns: example ethnicity: example fathers_ethnicity: example mothers_ethnicity: example country_of_birth: example town_or_city_of_birth: example preferred_language: example marital_status: example blood_group: example rhesus_factor: example address_line_1: example address_line_2: example town_or_city: example state_or_province: example postcode: example country: example is_donor: true is_deceased: true primary_user_id: 1 brand_id: 1 fund_source_id: 1 metadata: {} initial_contact_at: '2026-07-01T09:00:00.000000Z' first_seen_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient.identity_updated: post: operationId: canonical_v0_patient_identity_updated summary: canonical.v0.patient.identity_updated description: Delivered when a `canonical.v0.patient.identity_updated` event is published. Subscribe via the `canonical.v0.patient.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient.identity_updated data: type: object properties: record: "$ref": "#/components/schemas/PatientRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient.identity_updated sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 first_name: example last_name: example title: example patient_identity_management_id: example middle_name: example preferred_name: example full_legal_name: example date_of_birth: '2026-07-01' email: example sex_assigned_at_birth: example gender_identity: example pronouns: example ethnicity: example fathers_ethnicity: example mothers_ethnicity: example country_of_birth: example town_or_city_of_birth: example preferred_language: example marital_status: example blood_group: example rhesus_factor: example address_line_1: example address_line_2: example town_or_city: example state_or_province: example postcode: example country: example is_donor: true is_deceased: true primary_user_id: 1 brand_id: 1 fund_source_id: 1 metadata: {} initial_contact_at: '2026-07-01T09:00:00.000000Z' first_seen_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient.updated: post: operationId: canonical_v0_patient_updated summary: canonical.v0.patient.updated description: Delivered when a `canonical.v0.patient.updated` event is published. Subscribe via the `canonical.v0.patient.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient.updated data: type: object properties: record: "$ref": "#/components/schemas/PatientRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient.updated sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 first_name: example last_name: example title: example patient_identity_management_id: example middle_name: example preferred_name: example full_legal_name: example date_of_birth: '2026-07-01' email: example sex_assigned_at_birth: example gender_identity: example pronouns: example ethnicity: example fathers_ethnicity: example mothers_ethnicity: example country_of_birth: example town_or_city_of_birth: example preferred_language: example marital_status: example blood_group: example rhesus_factor: example address_line_1: example address_line_2: example town_or_city: example state_or_province: example postcode: example country: example is_donor: true is_deceased: true primary_user_id: 1 brand_id: 1 fund_source_id: 1 metadata: {} initial_contact_at: '2026-07-01T09:00:00.000000Z' first_seen_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_external_identifier.created: post: operationId: canonical_v0_patient_external_identifier_created summary: canonical.v0.patient_external_identifier.created description: Delivered when a `canonical.v0.patient_external_identifier.created` event is published. Subscribe via the `canonical.v0.patient_external_identifier.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_external_identifier.created data: type: object properties: record: "$ref": "#/components/schemas/PatientExternalIdentifierRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_external_identifier.created sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 identifier_type: example identifier_value: example issuing_jurisdiction: example valid_from: '2026-07-01' valid_to: '2026-07-01' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' primary: true responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_external_identifier.deleted: post: operationId: canonical_v0_patient_external_identifier_deleted summary: canonical.v0.patient_external_identifier.deleted description: Delivered when a `canonical.v0.patient_external_identifier.deleted` event is published. Subscribe via the `canonical.v0.patient_external_identifier.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_external_identifier.deleted data: type: object properties: record: "$ref": "#/components/schemas/PatientExternalIdentifierRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_external_identifier.deleted sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 identifier_type: example identifier_value: example issuing_jurisdiction: example valid_from: '2026-07-01' valid_to: '2026-07-01' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' primary: true responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_external_identifier.updated: post: operationId: canonical_v0_patient_external_identifier_updated summary: canonical.v0.patient_external_identifier.updated description: Delivered when a `canonical.v0.patient_external_identifier.updated` event is published. Subscribe via the `canonical.v0.patient_external_identifier.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_external_identifier.updated data: type: object properties: record: "$ref": "#/components/schemas/PatientExternalIdentifierRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_external_identifier.updated sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 identifier_type: example identifier_value: example issuing_jurisdiction: example valid_from: '2026-07-01' valid_to: '2026-07-01' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' primary: true responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_phone.created: post: operationId: canonical_v0_patient_phone_created summary: canonical.v0.patient_phone.created description: Delivered when a `canonical.v0.patient_phone.created` event is published. Subscribe via the `canonical.v0.patient_phone.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_phone.created data: type: object properties: record: "$ref": "#/components/schemas/PatientPhoneRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_phone.created sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 phone_type: example phone_number: example country_code: example preferred_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_phone.deleted: post: operationId: canonical_v0_patient_phone_deleted summary: canonical.v0.patient_phone.deleted description: Delivered when a `canonical.v0.patient_phone.deleted` event is published. Subscribe via the `canonical.v0.patient_phone.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_phone.deleted data: type: object properties: record: "$ref": "#/components/schemas/PatientPhoneRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_phone.deleted sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 phone_type: example phone_number: example country_code: example preferred_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_phone.updated: post: operationId: canonical_v0_patient_phone_updated summary: canonical.v0.patient_phone.updated description: Delivered when a `canonical.v0.patient_phone.updated` event is published. Subscribe via the `canonical.v0.patient_phone.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_phone.updated data: type: object properties: record: "$ref": "#/components/schemas/PatientPhoneRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_phone.updated sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 phone_type: example phone_number: example country_code: example preferred_at: '2026-07-01T09:00:00.000000Z' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_relationship.created: post: operationId: canonical_v0_patient_relationship_created summary: canonical.v0.patient_relationship.created description: Delivered when a `canonical.v0.patient_relationship.created` event is published. Subscribe via the `canonical.v0.patient_relationship.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_relationship.created data: type: object properties: record: "$ref": "#/components/schemas/PatientRelationshipRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_relationship.created sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 related_patient_id: 1 relationship_type: example same_sex_couple: true active_from: '2026-07-01' active_to: '2026-07-01' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_relationship.ended: post: operationId: canonical_v0_patient_relationship_ended summary: canonical.v0.patient_relationship.ended description: Delivered when a `canonical.v0.patient_relationship.ended` event is published. Subscribe via the `canonical.v0.patient_relationship.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_relationship.ended data: type: object properties: record: "$ref": "#/components/schemas/PatientRelationshipRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_relationship.ended sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 related_patient_id: 1 relationship_type: example same_sex_couple: true active_from: '2026-07-01' active_to: '2026-07-01' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.patient_relationship.updated: post: operationId: canonical_v0_patient_relationship_updated summary: canonical.v0.patient_relationship.updated description: Delivered when a `canonical.v0.patient_relationship.updated` event is published. Subscribe via the `canonical.v0.patient_relationship.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.patient_relationship.updated data: type: object properties: record: "$ref": "#/components/schemas/PatientRelationshipRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.patient_relationship.updated sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 related_patient_id: 1 relationship_type: example same_sex_couple: true active_from: '2026-07-01' active_to: '2026-07-01' source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.scheduler_event.created: post: operationId: canonical_v0_scheduler_event_created summary: canonical.v0.scheduler_event.created description: Delivered when a `canonical.v0.scheduler_event.created` event is published. Subscribe via the `canonical.v0.scheduler_event.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.scheduler_event.created data: type: object properties: record: "$ref": "#/components/schemas/SchedulerEventRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.scheduler_event.created sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 scheduler_event_type_id: 1 event_type: example title: example start_at: '2026-07-01T09:00:00.000000Z' end_at: '2026-07-01T09:00:00.000000Z' all_day: true status: example appointment_status: example scheduler_event_status_id: 1 location_id: 1 meeting_type: example notes: example internal_notes: example source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried. canonical.v0.scheduler_event.status_changed: post: operationId: canonical_v0_scheduler_event_status_changed summary: canonical.v0.scheduler_event.status_changed description: Delivered when a `canonical.v0.scheduler_event.status_changed` event is published. Subscribe via the `canonical.v0.scheduler_event.*` family (or this exact event name). security: [] parameters: - name: Wawa-Signature in: header required: true description: t=,v1=.`>. One `v1` entry per accepted secret, so two during the 24-hour rotation overlap. See this document's description for the verification steps. schema: type: string - name: Wawa-Event-Id in: header required: true description: Stable event UUID; identical to the body `id`. schema: type: string - name: Wawa-Delivery-Id in: header required: true description: Stable UUID for this endpoint's delivery and its retries. schema: type: string - name: Wawa-Endpoint-Id in: header required: true description: Stable UUID of the endpoint this delivery was sent to; identical on every retry. Use it to select the signing secret to verify against, and to identify which wawa account the delivery came from. schema: type: string requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/WebhookEnvelope" - type: object properties: type: const: canonical.v0.scheduler_event.status_changed data: type: object properties: record: "$ref": "#/components/schemas/SchedulerEventRecord" required: - record example: id: d1f8c0a2-6b3e-4c5a-9f21-0a1b2c3d4e5f type: canonical.v0.scheduler_event.status_changed sequence: 1 occurred_at: '2026-07-01T09:00:00.000000Z' originating_request_id: req_example data: record: id: 1 patient_id: 1 scheduler_event_type_id: 1 event_type: example title: example start_at: '2026-07-01T09:00:00.000000Z' end_at: '2026-07-01T09:00:00.000000Z' all_day: true status: example appointment_status: example scheduler_event_status_id: 1 location_id: 1 meeting_type: example notes: example internal_notes: example source_system: example deleted: '2026-07-01T09:00:00.000000Z' created_at: '2026-07-01T09:00:00.000000Z' updated_at: '2026-07-01T09:00:00.000000Z' external_identifier: example responses: '200': description: Acknowledge with any 2xx. Other statuses, redirects, timeouts, and network failures are retried.