RefKit Docs
Getting Started

Local Runtime Checklist

Repeatable steps to confirm API, queue, and worker execution.

1. Confirm API + Worker Reachability

  • GET /health should return 200.
  • Worker process should log Ready. queue=refkit-ingestion.

2. Verify SDK API Key Flow

  1. Create or reuse a business API key from the business dashboard.
  2. Send a non-referral event through /track.
  3. Confirm processedSynchronously: true for lightweight events.

3. Verify Referral Apply Branching

  • /sdk/referrals/apply with referredUserId is synchronous.
  • /sdk/referrals/apply with only referredUserEmail is accepted and queued.

4. Verify Queue Path

  • Call /track with eventName: "referral", valid referrer code, and referred identity in metadata.
  • Response should include queued: true in 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

On this page