Set App Embed Configuration

Create or update the App Embed integration configuration for an organization.

PUT /v1/org/{org_id}/ehr_integration/configuration

cURL

curl --request PUT \
  --url https://api.management.junction.com/v1/org/{org_id}/ehr_integration/configuration \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Key: <management-key>' \
  --data '{
    "slug": "my-clinical-practice",
    "modalities": ["feature_embed", "link_out"],
    "origin_configs": [
      {
        "origin": "https://app.example.com",
        "session_continuation_url": "https://app.example.com/junction/session-continuation"
      }
    ]
  }'

200

{
  "slug": "<string>",
  "modalities": [],
  "origin_configs": [
    {
      "origin": "<string>",
      "session_continuation_url": "<string>"
    }
  ]
}

{
  "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 PUT \
  --url https://api.management.junction.com/v1/org/{org_id}/ehr_integration/configuration \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Key: <management-key>' \
  --data '{
    "slug": "my-clinical-practice",
    "modalities": ["feature_embed", "link_out"],
    "origin_configs": [
      {
        "origin": "https://app.example.com",
        "session_continuation_url": "https://app.example.com/junction/session-continuation"
      }
    ]
  }'

Authorizations

X-Management-Key · string · header · required

Path Parameters

org_id · string<uuid> · required

Body

application/json

slug · string · required

Minimum string length: 3

modalities · enum<string>[] · required

Available options: feature_embed, link_out

origin_configs · AllowedOriginConfig · object[] · required

Show child attributes

Response

200

application/json

Successful Response

slug · string · required

modalities · enum<string>[] · required

Available options: feature_embed, link_out

origin_configs · AllowedOriginConfig · object[] · required

Show child attributes