Pull Endpoints Overview
Pull endpoints are a consumer-controlled alternative to traditional push-based webhook delivery. Instead of HookBridge forwarding events to your server, events are stored and made available for you to retrieve on demand through the API.
External providers send webhooks to a HookBridge ingestion URL, the same way inbound endpoints work. The difference: instead of forwarding the webhook to your server, HookBridge stores the event and lets you retrieve it when you are ready.
When to Use Pull Endpoints
Section titled “When to Use Pull Endpoints”Pull endpoints are a good fit when you:
- Run batch processes that consume events on a schedule rather than in real time
- Operate behind firewalls or networks that restrict inbound traffic
- Need backpressure control so you can process events at your own pace without being overwhelmed
- Want to avoid running a publicly accessible server just to receive webhooks
- Need to guarantee processing order by retrieving events chronologically
If you need real-time delivery to a server endpoint, use inbound endpoints instead.
- You create a pull endpoint in HookBridge.
- HookBridge gives you an
ingest_url. - You configure your external provider (Stripe, GitHub, etc.) to send webhooks to that
ingest_url. - HookBridge validates incoming requests using your configured verification settings.
- Accepted events are stored with status
stored. - You retrieve events via the API: list events, fetch individual payloads (which marks them as
fetched), and acknowledge when processed (which marks them asdelivered).
Key Concepts
Section titled “Key Concepts”- No delivery target. Pull endpoints do not forward events anywhere. You pull them when ready.
- Three-stage lifecycle. Events move through
stored,fetched, anddelivered. Retrieving an event’s payload marks it asfetched, but you must explicitly acknowledge events to mark them asdelivered. If your client crashes between fetching and processing, the event stays infetchedstatus and can be retrieved again. - Event type extraction. You can configure pull endpoints to extract an event type from each incoming webhook (from the JSON body or an HTTP header). This enables filtering when retrieving events.
- Same verification. Pull endpoints support the same verification options as inbound endpoints: HMAC, static token, and IP allowlist.
- Retention. Events are retained until your plan’s retention period expires or a per-endpoint retention override is reached. After acknowledgment, event payloads are cleaned up automatically, but event metadata remains available for re-retrieval and monitoring.
API reference:
Personalize Examples
Enter your credentials to populate code examples throughout the docs.