Documentation

Integrator documentation

How to call Foreshock, what each answer means, and what your client must do when an answer does not arrive. Written for the engineer wiring the deposit path, not for the buyer.

Get started

What Foreshock is, for an integrator
The shape of an integration
Authentication
Environments and testing

Concepts

The signal lifecycle
Coverage health
Verdicts, bands, and pools
Evidence and content-addressed snapshots

API

API overview
Pagination
Idempotency
Rate limits
Endpoint reference
Types and reason codes

Integrate

The fail-closed client contract
Integrating the credit gate
Webhook delivery and signature verification

Operate

When the data is degraded or stale
Budget exhaustion
Incidents and what to expect from us