Namespaces

Signals

ovok.signals turns on Signals monitoring for patients, calls the Signals API through the

  • Stable unknown
  • Release candidate since 0.1.0-rc.3
  • Development since 0.1.0-dev.21+c43ebba

ovok.signals turns on Signals monitoring for patients, calls the Signals API through the Ovok gateway, and repairs Signals configurations that could not be delivered.

Enable Signals for a patient

from ovok_sdk import Ovok

ovok = Ovok(
    "https://api.sandbox.ovok.com",
    "your-tenant",
    client_id="client-id",
    client_secret="client-secret",
)

ovok.signals.enable("patient-id")

Call the Signals API

gateway.request takes the path as a list of segments. Each segment is URL-encoded, and empty, ., .. or slash-containing segments raise OvokValidationError. A list-valued query parameter repeats.

patients = ovok.signals.gateway.request("GET", ["patient"], query={"limit": 5})

Repair undelivered configurations

pending = ovok.signals.undeliverable.list()
ovok.signals.undeliverable.repair()

API reference

See ovok_sdk.resources.signals for every method, parameter and error.

Last updated on

On this page