Quickstart
Set up your first Dokaai notification flow.
Quickstart
This guide walks through the first Dokaai flow at a product level: create a project, connect a provider, configure a notification handler, and trigger a test notification.
Before you start
Make sure you have:
- Access to a Dokaai organization and project.
- A channel provider account for the channel you want to test.
- An API key or backend credential for sending requests.
- A test customer or recipient identity.
Step 1: Open your workspace
Start from the Dokaai workspace that owns your notification setup. A workspace groups the projects, members, services, and delivery configuration used by your team.
If you are still learning the product model, read Workspace before wiring production flows.
Step 2: Connect a provider
Connect the provider you want to use for the first channel. For example, email, SMS, push, WhatsApp, chat, or in-app delivery.
Provider configuration usually includes credentials, sender details, and channel-specific settings. Keep provider credentials scoped to the right project or organization boundary.
Step 3: Create a notification handler
A notification handler is the reusable unit that defines a notification flow. It should describe what is sent, which channels can deliver it, and how recipients are resolved.
For your first handler, keep the setup small:
- Use one channel.
- Use one simple template.
- Use one test recipient.
- Publish only after the handler preview and test send look correct.
Step 4: Add recipient data
Dokaai can send to direct recipients or audiences, depending on the flow you are building. For a quickstart, use a known test customer so the request is easy to verify.
If your flow depends on grouped audiences, review customer pools, target audience lists, cohort segments, and notification groups in Core Concepts.
Step 5: Send a test notification
Use the API reference when you are ready to trigger the flow from your backend.
Start here:
Send the request from a controlled test environment first. Confirm the response status, delivery channel, recipient, and rendered message content before connecting the handler to a live product event.
Step 6: Add preferences and safeguards
Before using the flow in production, check the delivery rules around the handler:
- Customer preferences are respected.
- The provider integration is active.
- Required template variables are present.
- Retry and failure behavior is understood.
- The handler is published intentionally.
Next steps
After the first send works, continue with:
- Core Concepts for the product model.
- Integration for provider and system connections.
- API Reference for backend automation.