DevelopersReturn to site
API Reference

Pathway Configs

Configure inbox pathways via the Jump EHR API. Control how clinical events create and route into episodes.

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.

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.

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.

GET
/pathway-configs

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100
Default20
offset?integer

Number of records to skip (default 0)

Range0 <= value
Default0
trigger_type?string
enabled?string
journey_type?string
creation_mode?string

Response Body

application/json

curl -X GET "https://example.com/pathway-configs"
{  "data": [    {      "id": "string",      "trigger_type": "string",      "enabled": true,      "creation_mode": "create_episode",      "inbox_visibility": "surface",      "journey_type": "string",      "expected_next_actor": "practice",      "conditions": {},      "event_message_template": "string",      "event_title_template": "string",      "created_at": "string",      "updated_at": "string"    }  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/pathway-configs/{id}

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/pathway-configs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "string",    "trigger_type": "string",    "enabled": true,    "creation_mode": "create_episode",    "inbox_visibility": "surface",    "journey_type": "string",    "expected_next_actor": "practice",    "conditions": {},    "event_message_template": "string",    "event_title_template": "string",    "created_at": "string",    "updated_at": "string"  },  "meta": {    "request_id": "req_abc123"  }}

Try-it is disabled for PATCH /pathway-configs/{id}

This operation writes data. Running it from these docs would target the production API and change a real record. Copy the request sample and run it against staging first.

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/pathway-configs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "trigger_type": "string",    "enabled": true,    "creation_mode": "create_episode",    "inbox_visibility": "surface",    "journey_type": "string",    "expected_next_actor": "practice",    "conditions": {},    "event_message_template": "string",    "event_title_template": "string",    "created_at": "string",    "updated_at": "string"  },  "meta": {    "request_id": "req_abc123"  }}