Skip to main content

Acknowledge a Signals alert episode

MethodPath
POST/v1/signals/alerts/:episodeId/ack

Shared authentication, project scope, and response conventions.

Acknowledges and closes an episode. A later reading that breaches the rule can open a new episode.

Requirement or resultDetails
Access policysignals_alerts:update and Patient update
Caller profileA person profile is required and recorded as acknowledgedActor.
RequestNo body. :episodeId is the Signals episode id.
Success200 with the updated episode. The acknowledgment response has noteCount: null.
IdempotencyIf the episode was already acknowledged, Ovok does not acknowledge it again. It records this call as already acknowledged and returns the episode unchanged.
curl --request POST \
--url 'https://api.sandbox.ovok.com/v1/signals/alerts/0b6f8c1e-2a4d-4e7b-9c3f-1d5e8a7b6c4d/ack' \
--header "Authorization: Bearer ${OVOK_TOKEN}"
StatusMeaning
403Missing signals_alerts:update, Patient update access, or person profile.
404Episode is missing, outside the project, or tied to an unreadable Patient.
409 signals_episodes_disabledProject episode alerts are disabled.
409Another acknowledgement for this episode is running. Retry after it completes.
503 signals_audit_failedThe audit record could not be created, so the acknowledgement was not sent. Retrying is safe.