Getting Started
Local Runtime Checklist
Repeatable steps to confirm API, queue, and worker execution.
1. Confirm API + Worker Reachability
GET /healthshould return200.- Worker process should log
Ready. queue=refkit-ingestion.
2. Verify SDK API Key Flow
- Create or reuse a business API key from the business dashboard.
- Send a non-referral event through
/track. - Confirm
processedSynchronously: truefor lightweight events.
3. Verify Referral Apply Branching
/sdk/referrals/applywithreferredUserIdis synchronous./sdk/referrals/applywith onlyreferredUserEmailis accepted and queued.
4. Verify Queue Path
- Call
/trackwitheventName: "referral", valid referrer code, and referred identity in metadata. - Response should include
queued: truein async branch. - Worker should complete the corresponding ingestion job.
5. Verify Failure Handling
- Failed jobs retry with exponential backoff.
- After attempts are exhausted, worker pushes payload to
refkit-dead-letter.
6. Quick Sign-Off Template
Use this format after each e2e pass:
Runtime Sign-Off (Port 4000)
- API health: PASS
- Sync track path: PASS
- Queue referral path: PASS
- Worker completion: PASS
- DLQ regressions: NONE
Result: READY