Difficulty: Advanced | Time: 15 min | Tier: Scale & Above
Scale Tier & Above
API access and custom webhooks require Scale tier or higher.
The DreamFlow API lets developers build custom integrations, sync data with external systems, and automate workflows programmatically. Combined with outgoing webhooks, you can create real-time data pipelines between DreamFlow and any system.
Getting Your API Key
- Go to Settings > Integrations > API.
- Click Generate API Key.
- Copy the key immediately -- it is shown only once.
- Store it securely in your application's environment variables.
Important
Your API key grants full access to your workspace data. Never expose it in client-side code, public repositories, or browser requests. Use it only in server-to-server calls.
Authentication
Include your API key in the Authorization header of every request:
Authorization: Bearer your_api_key_here
Available Endpoints
GET /api/v1/contacts-- List contacts with pagination and filtersPOST /api/v1/contacts-- Create a new contactGET /api/v1/deals-- List deals by pipeline and stagePOST /api/v1/deals-- Create a new dealGET /api/v1/tasks-- List tasks with status filtersPOST /api/v1/tasks-- Create a task
Webhook Endpoints
Configure outgoing webhooks to receive real-time event notifications:
- Go to Settings > Integrations > Webhooks.
- Click Add Endpoint.
- Enter your server's URL and select which events to subscribe to.
- DreamFlow sends a
POSTrequest with a JSON payload for each event.
Webhook Payload Format
Every webhook payload includes:
{
"event": "contact.created",
"timestamp": "2026-03-22T10:30:00Z",
"data": {
"id": "uuid",
"full_name": "Jane Doe",
"email": "jane@example.com"
}
}
Verifying Webhook Signatures
Each webhook request includes an X-DreamFlow-Signature header. Verify this HMAC-SHA256 signature against your webhook secret to ensure the request is authentic.
Tip
Always verify webhook signatures in production. This prevents malicious actors from sending fake events to your endpoint.
Related Articles
Need more help? Ask Sally in the chat bubble!
Was this helpful?
Have more questions? Get instant answers.
Related Articles
Still need help? Our support team is here for you.
Contact Support