Read the webhook endpoint
Read the webhook endpoint, through Ovok's Signals gateway.
Read the webhook endpoint
| Method | Path |
|---|---|
GET | /v1/signals/api/subscriber/{id}/webhook |
- Sandbox: available
- Staging: available
- Production: unknown
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.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The subscriber's Signals id or its clientId. |
Responses
| Status | Meaning |
|---|---|
200 | The endpoint. |
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. 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 | No such 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. |
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/subscriber/:id/webhook' \
--user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"Last updated on