Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cable alerts API

The alerts API from Cable — 1 operation(s) for alerts.

Cable alerts API is one of 20 APIs that Cable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include alerts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 1 path, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cable.tech.

3 operations 1 paths 15 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.cable.tech
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Cable alerts API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

alerts 3
GET
/transaction_alert
Check if a transaction alert exists
check-transaction-alert 2 params → 200401404429500
POST
/transaction_alert
Add new transaction alert(s)
add-transaction-alert 1 param body → 201400401409429500
PUT
/transaction_alert
Update an existing transaction alert
update-transaction-alert 1 param body → 200400401404429500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are TransactionAlert (6 properties), NewTransactionAlertRequestItems (6 properties), UpdateTransactionAlertRequest (6 properties), AdditionalProperties (4 properties). Each schema is shown below with its type and property counts.

AdditionalPropertiesType
string
The type of the additional property value, for example "string", "number", "boolean", "object", "array".
TransactionAlertCheckType
string
The type of monitoring check that triggered the alert.
NewTransactionAlertRequestItemsStatus
string
TransactionAlertStatus
string
GeneralErrorErrorsItems
object
2 properties
NewTransactionAlertRequestItemsCheckType
string
The type of monitoring check that triggered the alert.
TransactionAlert
object
6 properties 2 required
AdditionalProperties
object
Additional metadata that can be added to a payload, such as transaction checks, alerts, and suspicious activities.
4 properties 4 required
UpdateTransactionAlertRequest
object
Transaction alert data to update, referenced by 'alertid'. The 'timestamp' field represents the update time. Only the fields to be updated need to be included.
6 properties 2 required
NewTransactionAlertRequest
array
Transaction alert data to add. 'checkid' is optional and can be updated later to associate the alert to the transaction check.
NewTransactionAlertRequestItems
object
6 properties 3 required
UpdateTransactionAlertRequestCheckType
string
The type of monitoring check that triggered the alert.
Alerts_checkTransactionAlert_Response_200
object
4 properties
GeneralError
object
3 properties 2 required
UpdateTransactionAlertRequestStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cable-alerts-api-openapi.yml Raw ↑

Other APIs Cable publishes across the network.

Cable authentication API
Cable business API
Cable checks API
Cable company API
Cable customerSar API
Cable helper API
Cable identityVerification API
Cable onboardingFlow API
Cable person API
Cable retail API
Cable riskAssessment API
Cable screening API