OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Signals API - Clients

Enable the webhook endpoint

  • Sandbox: available
  • Staging: available
  • Production: unknown
POST
/v1/signals/api/subscriber/{id}/webhook/enable

Resumes deliveries of new events. It re-queues nothing: events held while it was disabled go out only through POST /api/events/redeliver?status=held. Enabling an enabled endpoint changes nothing.

Through ovok

  • Who can call it: Manager apps, and users whose access policy grants the capabilities.
  • Capabilities, all required: signals_webhooks:update. Project admins have every capability; client applications get no admin bypass.
  • 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.

Authorization

headerAuthorizationBearer <JWT>

Path Parameters

id*string

The subscriber's Signals id or its clientId.

Response Body

The endpoint as it now stands.

application/json
  1. response
subscriberId*string
url*string
status*string

failing: the newest attempts failed; five days of that disables it. disabled: nothing is sent, and new events are held.

Value in"enabled""failing""disabled"
disabledAt*string
Formatdate-time
disabledReason*string

gone: it answered 410. failing: five days of failures. manual: disabled by a caller.

Value in"gone""failing""manual"
failingSince*string

When the current run of failures began.

Formatdate-time
lastSuccessAt*string
Formatdate-time
lastFailureAt*string
Formatdate-time
Example Request
curl -X POST 'https://api.sandbox.ovok.com/v1/signals/api/subscriber/string/webhook/enable'
Example Response
{  "subscriberId": "string",  "url": "string",  "status": "enabled",  "disabledAt": "2019-08-24T14:15:22Z",  "disabledReason": "gone",  "failingSince": "2019-08-24T14:15:22Z",  "lastSuccessAt": "2019-08-24T14:15:22Z",  "lastFailureAt": "2019-08-24T14:15:22Z"}

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.

Disable the webhook endpoint POST

Stops deliveries. Queued events and new ones are held, not dropped, for a redeliver once it is enabled again. Disabling a disabled endpoint keeps its first reason. ### Through ovok - **Who can call it:** Manager apps, and users whose access policy grants the capabilities. - **Capabilities, all required:** `signals_webhooks:update`. Project admins have every capability; client applications get no admin bypass. - 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.