Create Dashboard URL

Create a post-authorization URL that launches Junction Dashboard for a Junction Connect member.

POST /v1/org/{org_id}/ehr_integration/create_dashboard_url

cURL

curl --request POST \
  --url https://api.management.junction.com/v1/org/{org_id}/ehr_integration/create_dashboard_url \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Key: <management-key>' \
  --data '{
    "integration_member_id": "user_456",
    "integration_team_id": "clinic_123",
    "modality": "feature_embed",
    "feature": "order_creation",
    "environment": "sandbox"
  }'

200

{
  "url": "<string>",
  "expires_in": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Junction Management API is available for the Scale plan.

The base URL of this endpoint is https://api.management.junction.com/.

The endpoint accepts only Management Key (X-Management-Key). Team API Key is not accepted.

cURL

curl --request POST \
  --url https://api.management.junction.com/v1/org/{org_id}/ehr_integration/create_dashboard_url \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Key: <management-key>' \
  --data '{
    "integration_member_id": "user_456",
    "integration_team_id": "clinic_123",
    "modality": "feature_embed",
    "feature": "order_creation",
    "environment": "sandbox"
  }'

Authorizations

X-Management-Key · string · header · required

Path Parameters

org_id · string<uuid> · required

Body

application/json

feature · string · required

modality · enum<string> · required

Available options: feature_embed, link_out

environment · enum<string> · required

Available options: production, sandbox

member_id · string<uuid> | null

integration_member_id · string | null

Maximum string length: 256

team_id · string<uuid> | null

integration_team_id · string | null

Maximum string length: 256

Response

200

application/json

Successful Response

url · string<uri> · required

Minimum string length: 1

expires_in · integer · required