Pathway Configs

Pathway configs control how clinical events (appointment bookings, lab results, questionnaire submissions, etc.) create or route into episodes. Each trigger type has one config per organisation.

Endpoints

Method	Endpoint	Description
`GET`	`/pathway-configs`	List all configs
`GET`	`/pathway-configs/{id}`	Retrieve a config
`PATCH`	`/pathway-configs/{id}`	Update a config

Configs are created automatically for each trigger type — you cannot create or delete them. Use PATCH to modify settings. To disable a pathway, set enabled: false.

The Config Object

{
  "id": "cfg_123e4567-e89b-12d3-a456-426614174000",
  "trigger_type": "appointment.booked",
  "enabled": true,
  "creation_mode": "attach_or_create",
  "inbox_visibility": "surface",
  "journey_type": "access",
  "expected_next_actor": "practice",
  "conditions": {},
  "event_message_template": null,
  "event_title_template": null,
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Creation Modes

Mode	Description
`create_episode`	Always create a new episode
`attach_or_create`	Attach to existing open episode of same journey type, else create new
`attach_only`	Only attach to existing episodes, never create
`log_only`	Event logged but no episode created or modified

Trigger Types

appointment.booked, appointment.cancelled, appointment.rescheduled, questionnaire.submitted, lab_result.received, invoice.created, prescription.signed, identity_verification.completed, clinical_access.requested, message.sent, message.received, document.uploaded

List Configs

GET /pathway-configs

Sorted by trigger_type ascending.

Query Parameters

Parameter	Type	Description
`limit` / `offset`	integer	Pagination (default 20)
`trigger_type`	string	Filter by trigger type
`enabled`	string	Filter enabled/disabled
`journey_type`	string	Filter by journey type
`creation_mode`	string	Filter by creation mode
`inbox_visibility`	string	`surface` or `silent`

Update a Config

PATCH /pathway-configs/{id}

Updatable Fields

Field	Type	Validation
`enabled`	boolean	Enable/disable this pathway
`creation_mode`	string	`create_episode`, `attach_or_create`, `attach_only`, `log_only`
`inbox_visibility`	string	`surface` or `silent`
`journey_type`	string	Episode journey type classification
`expected_next_actor`	string	`practice` or `patient`
`conditions`	object	Base condition filtering (JSON object)
`event_message_template`	string	Template for event message
`event_title_template`	string	Template for event title

Safety Floors

⚠️

Certain trigger types have safety floors that prevent you from reducing the creation mode or hiding inbox visibility below a minimum threshold. This protects clinically significant events from being silenced.

Trigger Type	Min Creation Mode	Min Visibility
`lab_result.received`	`create_episode`	`surface`
`prescription.signed`	`create_episode`	`surface`
`identity_verification.completed`	`create_episode`	`surface`
`clinical_access.requested`	`create_episode`	`surface`
`appointment.booked`	`attach_or_create`	`surface`
`questionnaire.submitted`	`attach_or_create`	`surface`
`message.received`	`attach_or_create`	`surface`
`invoice.created`	`attach_only`	`surface`

Attempting to set a value below the floor returns 422 VALIDATION_ERROR with details explaining the constraint.

Related Resources

Pathway Rules - Conditional override rules
Episodes - Episodes created by these pathways

Appointment Templates Pathway Rules