---
title: "Receive Ehr Event Step"
method: POST
path: "/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}"
tags: ["Campaigns"]
---

# Receive Ehr Event Step

`POST /api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}`

## Request

- Base URL: `https://voice.getprosperapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://voice.getprosperapp.com/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}`
- Auth: none declared

## Path parameters

- `campaign_id` string, required: The ID of the campaign.
- `friendly_id` string, required: The friendly ID of the step.

## Request body

- BodyReceiveEhrEventStepApiV1CampaignsCampaignIdEhrEventFriendlyIdPost
  - `event_type` 'appointment_created' | 'appointment_cancelled' | 'patient_registered', required
  - `event_data` object
  - `target_id` string, nullable: Optional target ID.
  - `external_id` string, nullable: Optional external ID.

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getprosperapp/apis/prosper-voice.md) - [All operations](https://skmtc.dev/getprosperapp/apis/prosper-voice/llms.txt) - [OpenAPI document](https://skmtc.dev/getprosperapp/apis/prosper-voice/revisions/acd73a3750ca?raw)