How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

brightback Retention API

The Retention API from brightback — 1 operation(s) for retention.

brightback Retention API is published by brightback on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.brightback.com, https://app.retention.chargebee.com.

1 operations 1 paths 5 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.brightback.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

brightback Retention API declares 2 security schemes for authenticating requests. An API key is passed in the header as Signature (hmacSignature). An API key is passed in the header as Signature-Public-Key (hmacPublicKey). By default, every request must be authenticated.

  • hmacSignature — HMAC-SHA-512 signature computed over the request payload plus an ISO8601 timestamp, using the account's Brightback-issued private key.
  • hmacPublicKey — The Brightback-issued public key identifying the signing account.

Paths & Operations 1

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

Retention 1
POST
/precancel
Create a pre-cancel (save) session
createPrecancelSession body → 200400401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PrecancelRequest (11 properties), Account (8 properties), Context (5 properties), PrecancelResponse (3 properties). Each schema is shown below with its type and property counts.

Context
object
End-user context captured by the browser client.
5 properties
PrecancelResponse
object
3 properties
PrecancelRequest
object
11 properties 2 required
ErrorResponse
object
2 properties
Account
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brightback-retention-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of brightback Retention API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.