Skip to content

Sparrow

Browse the full API reference below. Each service page includes request and response schemas, field constraints, and auto-generated curl examples you can copy and run directly. Enum types are documented separately with all values and descriptions.

  • WebhookService — WebhookService manages webhook registration, configuration, and lifecycle. All RPCs require a namespace. Webhooks are…
  • EventService — EventService manages event type definitions and event pushing. Event types must be registered before they can be push…
  • SubscriptionService — SubscriptionService manages the mapping between webhooks and event types. A subscription links one webhook to one eve…
  • DeliveryService — DeliveryService provides read access to delivery history and manual retry control. Deliveries are created automatical…
  • HealthService — HealthService provides webhook health metrics derived from delivery outcomes. Health is computed per-webhook based on…
  • WebhookDeliveryStatus — WebhookDeliveryStatus tracks the lifecycle of a single delivery. State transitions: PENDING -> SENDING -> SUCCESS PEN…
  • WebhookHealth — WebhookHealth represents the computed health status of a webhook endpoint. Health is derived from recent delivery out…