List webhook events
List webhook events, through Ovok's Signals gateway.
List webhook events
| Method | Path |
|---|---|
GET | /v1/signals/api/events |
- Sandbox: available
- Staging: available
- Production: unknown
Every event addressed to the caller, oldest first and keyset paged by cursor, each with its delivery status and payload: expired, failed and held ones too. An event is listed once it is two minutes old, so a page never moves past one a slower transaction has yet to commit. Filter by types, status, patientId, or (for a MANAGER) subscriberId.
Through ovok
- Who can call it: Manager apps, and users whose access policy grants the capabilities.
- Capabilities, all required:
signals_events:read. Project admins have every capability; client applications get no admin bypass. - If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), name them with
patientId, each one you can read, at most 100. Signals then pages over just those patients, so pages and totals stay true. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes arefId; ovok asks Signals which patient a Signals id is.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque keyset cursor: a previous answer's nextCursor, passed back verbatim. |
limit | number | No | Page size, 1 to 200. Defaults to 50. |
types | array of string | No | Only these event types, comma-separated: alert.trigger,patient.inactive. |
status | failed, delivered, pending, expired, held | No | Only deliveries in this state. |
patientId | string | No | Only events about this patient: its Signals id, as the payload's patient. |
subscriberId | string | No | Only this subscriber's deliveries, by Signals id or clientId. A subscriber may name only itself. |
Responses
| Status | Meaning |
|---|---|
200 | One page of events. |
400 | The query carries a raw #, or more than 200 parameters. |
401 | Your ovok access token, or your client id and secret, are missing or invalid. |
403 | ovok refused the call: you lack a capability this route needs, or your session has no project, or your access covers only some patients and the call names none. From Signals: Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber. |
404 | A patient the call names is not one you can read. From Signals: subscriberId names no subscriber in this tenant. |
409 | Your project has no Signals tenant of its own (SIGNALS_TENANT_NOT_OWN), or it is moving to another one. |
422 | A patient id is not 1 to 64 letters, digits, ., _, ~ or -. More than 100 patients are named. From Signals: A query parameter failed validation. |
429 | Too many requests. Retry after the seconds in Retry-After. |
500 | ovok hit an unexpected fault, such as your project having no Signals submitter. |
502 | Signals answered with something ovok couldn't use, or refused ovok's own credential. |
503 | Signals is unavailable. Retry after the seconds in Retry-After. |
504 | Signals did not answer in time. |
Example
curl --request GET 'https://api.sandbox.ovok.com/v1/signals/api/events' \
--user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"Last updated on