Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
ehr-event
/
{friendly_id}
Receive Ehr Event Step
curl --request POST \
  --url https://api.example.com/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_data": {},
  "target_id": "<string>",
  "external_id": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getprosperapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
campaign_id
string
required

The ID of the campaign.

​
friendly_id
string
required

The friendly ID of the step.

Body

application/json
​
event_type
enum<string>
required

The type of EHR event.

Available options:
appointment_created,
appointment_cancelled,
patient_registered
​
event_data
Event Data · object
​
target_id
string | null

Optional target ID.

​
external_id
string | null

Optional external ID.

Response

Successful Response