Data feed
Guper exposes two append-only feeds that publish a notification every time a customer or order changes. Your downstream system polls them on its own cadence and acknowledges what it has consumed — at-least-once delivery, no webhooks to manage, no public endpoint to expose.
Two feeds:
- Customer feed — entries land here when a customer is created, updated, tagged or has profile data changed.
- Order feed — entries land here when an order is created, modified, cancelled or has rewards/promotions applied.
The three-step flow
┌────────────┐ ┌────────────┐ ┌────────────┐
│ 1. Pull │ → │ 2. Fetch │ → │ 3. Ack │
│ feed │ │ detail │ │ token │
└────────────┘ └────────────┘ └────────────┘
Step 1 — Pull the feed
GET the feed endpoint to receive a list of { id, token } pairs. Each token uniquely identifies that pending entry; once you ack it (step 3) it disappears from the feed.
GET /api/register/customer/feed
GET /api/order/feed
Step 2 — Fetch the full record
For each entry, GET the corresponding resource by ID:
GET /api/register/customer/{personId}
GET /api/order/{orderId}
Step 3 — Acknowledge
PUT the token back to the feed to confirm you've consumed the entry. Until you do, it keeps showing up in subsequent pulls.
PUT /api/register/customer/feed
{ "token": "<token from step 1>" }
Why polling instead of webhooks?
- No public endpoint exposed by your side — easier on InfoSec.
- At-least-once delivery — a crashed worker re-polls and picks up where it left off; we never silently drop an event.
- Backpressure built in — you decide the cadence; the feed waits.
- Replay isn't a separate API — you control progress with acks.
Cadence guidance
For most operational integrations, polling every 10–30 seconds is plenty. For analytics/BI mirrors that don't need real-time freshness, 5 minutes is fine. There's no minimum interval enforced.
Authentication
Both feed endpoints require a valid x-guper-authorization token — see Authentication.
See also
- Integration landscape — where the feed fits in the bigger picture
- List query parameters — the
q[]/o[]/e/pgrammar applies to feed pulls when you need filtered tails