Delete a user
- Sandbox: available
- Staging: available
- Production: unknown
Revokes the credential at once and drops its undelivered webhook events.
Through ovok
- Who can call it: Manager apps, and users whose access policy grants the capabilities.
- Capabilities, all required:
signals_webhooks:delete. Project admins have every capability; client applications get no admin bypass. - Only subscribers are deleted through ovok.
- 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.
AuthorizationBearer <JWT>id*stringDeleted: the id of the user that is gone.
application/json- response
_id*stringid*stringcurl -X DELETE 'https://api.sandbox.ovok.com/v1/signals/api/user/string'{ "_id": "string", "id": "string"}Update a user POST
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`, `secret` and `webhookSecret` can'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.
Read the webhook endpoint GET
The URL, whether it is `enabled`, `failing` or `disabled` (and why), when its current run of failures began, and its newest delivered and failed attempts. Five days of failures with no delivery, or one 410, disable it. ### Through ovok - **Who can call it:** Manager apps, and users whose access policy grants the capabilities. - **Capabilities, all required:** `signals_webhooks:read`. Project admins have every capability; client applications get no admin bypass.