Update a user
Update a user, through Ovok's Signals gateway.
Update a user
| Method | Path |
|---|---|
POST | /v1/signals/api/user/{id} |
- Sandbox: available
- Staging: available
- Production: unknown
Sets the name, webhook target, signing secret, events, event schema, reach or credential secret.
Through ovok
- Who can call it: Manager apps, and users whose access policy grants the capabilities.
- Capabilities, all required:
signals_webhooks:update,signals_events:read. Project admins have every capability; client applications get no admin bypass. - Only subscribers are changed through ovok. Their
role,eventSchema,clientId,secretandwebhookSecretcan't be sent. - It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The client's Signals id. |
Body
Required.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | — |
webhookUrl | string | No | — |
events | array of string | No | — |
custom | string | No | v1's custom: an opaque string every webhook carries back as x-actimi-custom. |
reach | attached, all | No | — |
Responses
| Status | Meaning |
|---|---|
200 | The user as it now stands. |
400 | A path value holds a character ovok does not send to Signals, such as a raw : or +. Percent-encode it. 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 the user is not a subscriber, or your access covers only some patients. From Signals: Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: FEATURE_DISABLED: events names an episode event, and the tenant has episodicAlerts off, so it records none. |
404 | No such client in this tenant. |
409 | Your project has no Signals tenant of its own (SIGNALS_TENANT_NOT_OWN), or it is moving to another one. |
415 | The body is not JSON. |
422 | role, eventSchema, clientId, secret or webhookSecret was sent. From Signals: The payload failed validation. EVENTS_NOT_IN_SCHEMA: the events and eventSchema it would leave never match, such as alert.trigger on schema 2. Change both in one call. |
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 POST 'https://api.sandbox.ovok.com/v1/signals/api/user/:id' \
--user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}" \
--header 'Content-Type: application/json' \
--data @body.jsonLast updated on