> ## Documentation Index
> Fetch the complete documentation index at: https://docs.airlead.de/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference introduction

> Public webhook and utility endpoints for Airlead partners.

# API reference introduction

This reference defines the supported HTTP contracts for partner integrations:

* Lead ingest webhooks
* Transaction confirmation, rejection, Storno, and payout callbacks
* The generic outbound buyer webhook payload
* Health check

Endpoints used internally by the Airlead web app are not a public integration contract.

## Conventions

* JSON request/response
* `Content-Type: application/json`
* ISO 8601 timestamps where present
* Opaque IDs; do not infer meaning from their format
* Secrets in `X-Airlead-Webhook-Secret` or `Authorization: Bearer`
* Stable external IDs for idempotent ingest
* Transaction IDs for buyer lifecycle callbacks

## Before implementation

1. Create the source or buyer in Airlead.
2. Obtain the exact URL and credential for that resource.
3. Use synthetic data in a test configuration.
4. Verify duplicate and retry behavior.
5. Store credentials outside code and logs.

## OpenAPI

Machine-readable specification: [`openapi.yaml`](/openapi.yaml).

Validate local changes with:

```bash theme={null}
node docs/scripts/check-openapi.js
```