Skip to content
APIs and webhooks

Move events through explicit, observable contracts.

Use bounded API requests and signed webhook events to bring structured evidence into ReturnValue while retaining identity, timing, version, and delivery status.

Evidence-grade intelligence · Human validation · Traceable decisions
APIs & Webhooks / evidence viewIn development
observable event delivery
AuthenticateReceiveValidateProcess
Retry observableQuarantined for review
Illustrative view
  • ContractsVersioned and explicit
  • EventsAuthenticated at intake
  • DeliveryRetries observable
  • FailuresQuarantined and owned
In development

Programmatic API and webhook access is in development.

This page describes the exchange model we are building. There is no public endpoint to call today, and no published schema, credential type, or delivery commitment. If automated intake is on your roadmap, tell us what you need to send and when.

The ReturnValue approach

Automation should increase traceability—not hide it.

ReturnValue treats every request and event as a governed exchange with an authenticated source, defined schema, idempotent handling, and reviewable delivery history.

01

Authenticate the source

Use scoped credentials, signature verification, tenant context, and explicit authorization for each integration path.

02

Validate the contract

Reject or quarantine unsupported versions, missing fields, invalid types, duplicates, and out-of-order events.

03

Observe delivery

Expose receipt, processing, retry, dead-letter, and resolution status without leaking sensitive payload details.

What is being designed

Working backwards from real use.

A typed API for pushing data into ReturnValue, and webhooks for reacting to changes inside it, are in active development with design partners. Neither surface is available yet; this page reflects what is being designed, not what is shipped. There is no public endpoint to call today, and we are not shipping a generic API kit until it holds up against real use.

The ingest API is designed as a typed endpoint for pushing structured records or files into a workspace, with the same schema discipline as a manual upload. Outbound webhooks are designed for subscribing to changes inside a workspace, such as an insight regenerated, a dataset updated, or an audit event recorded.

A generic create-read-update-delete API is easy. A useful one holds up against the patterns teams actually run: nightly batch ingest, change-driven webhooks into a downstream system, signed payloads that support the receiver security review. We are designing against those patterns rather than a feature checklist. This page will say available when the surface clears that bar, not before.

Scoped keys
Keys are planned to be scoped to a single workspace and a narrow set of operations, with rotation and revocation as first-class operations.
Planned webhook signing
Outbound webhooks are planned to be signed so the receiver can verify origin and reject replays.
Planned retry semantics
Idempotent ingest and at-least-once outbound delivery, with documented rate limits and backoff hints, so retries are safe and observable.
Delivery visibility
A delivery view is planned to surface recent webhook attempts and response codes for debugging and observability.
Connected investigation

Reliable exchanges from source event to investigation record.

A failed delivery becomes a visible operational exception rather than a silent hole in the evidence timeline.

  1. 01AuthenticateSource verified
  2. 02ReceiveEvent identified
  3. 03ValidateContract checked
  4. 04ProcessIdempotently handled
  5. 05ObserveOutcome recorded
Evidence in context

Clarity at every decision point.

An integration is dependable when success and failure are equally visible.

Illustrative view. Values shown are examples, not customer data.

Delivery record

Success and failure both visible
  1. Event receivedsignature verified · source identified
  2. Contract checkedversion accepted · fields validated
  3. Processed onceidempotent · retry recorded if needed
See ReturnValue in your environment

Follow your first financial signal.

APIs & Webhooks — Integrations | ReturnValue.ai