API

Copy page
View as Markdown Open the public raw markdown route

Webhooks

The public webhook posture for Auk event delivery and operator-side integration boundaries.

Webhooks are the delivery channel that turns Auk lifecycle events into partner system notifications.

Relationship To Events

Webhooks should never invent a second lifecycle model.

They exist to deliver the same event truth that the API and operator surfaces already rely on.

Delivery Shape

runtime event created
  -> delivery attempt generated
  -> partner endpoint receives payload
  -> retry / success / failure recorded

Delivery And Retry Foundation

Webhook delivery is the contract layer that will eventually sit around event families, payout release notifications, and reconciliation follow-up. This section now gives the API tab a real anchor whenever the current docs context is about delivery, retries, or partner endpoint behavior.

Public Expectations

  • webhook payloads should reuse the public event vocabulary
  • delivery attempts should be observable
  • failures should be retryable
  • partner endpoints should be testable in sandbox before live use

Why This Page Matters Now

The docs corpus needs a webhook concept anchor early so the later API tab can connect endpoint summaries, delivery behavior, and operator guidance without forcing everything through one generic API overview page.