Skip to content

Webhooks Overview — Proposed Guide

Planned API — Reference Only

Webhooks Overview: Webhooks would notify a future authorized consumer that a business event occurred. An event notification is not an instruction to…

Overview

Webhooks would notify a future authorized consumer that a business event occurred. An event notification is not an instruction to approve an expense or execute a payment.

Key concepts

Separate event identity, resource identity and delivery attempt identity. Consumers should handle duplicate and out-of-order notifications.

Implementation considerations

No webhook is transmitted or subscribed from this website. Delivery guarantees and event availability remain proposed.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture
Fictional concept fixture
{
  "reference_only": true,
  "topic": "Webhooks Overview",
  "event_id": "event_example_123",
  "event_type": "expense.updated",
  "resource_id": "resource_example_123",
  "occurred_at": "2026-01-15T12:00:00Z"
}

Design review checklist

  • Document which organization owns the webhooks overview representation and which actor may view or change it.
  • Test the boundaries of event id, event type, resource id, occurred at using synthetic values, including missing or inconsistent references.
  • Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
NameTypeDescription
event_idstringStable fictional event reference; not a secret and not evidence that a resource exists.
event_typestringIllustrative business-fact name, not an instruction to move funds.
resource_idstringStable fictional resource reference; not a secret and not evidence that a resource exists.
occurred_atstring (date-time)Synthetic UTC timestamp. Business occurrence time may differ from delivery or processing time.