GuidesOfficial Starter Repositories

Official Starter Repositories

Last updated 2026-02-12

Rooaak ships official starter repositories for channel integration and custom UI embedding:

Purpose split

  • rooaak-core: API, runtime contracts, SDK, and webhook reliability.
  • Starter repos: provider-specific wiring, provider auth/signature checks, and deployable examples.

Starter repo requirements

Each starter should include:

  1. .env.example with only required variables.
  2. Signature verification for inbound webhooks.
  3. Replay/idempotency protection for duplicate events.
  4. README.md with setup, local run, and webhook registration steps.
  5. DEPLOYMENT.md and deployment templates (for example, Docker and Render).
  6. Basic tests for signature/parsing helpers.
  7. OSS license (MIT) and an explicit support policy (SUPPORT.md).

Compatibility contract

All starters should map into:

  • Inbound: POST /v1/agents/:id/messages
  • Completion: message.responded webhook + GET /v1/messages/:id fetch
  • Metadata convention:
    • metadata.channel.type in custom_ui | slack | whatsapp_cloud
    • metadata.correlationId for provider/app correlation