Loading...
Use the DreamFlow API and webhooks to build custom integrations and automate workflows programmatically.
Last updated March 23, 2026
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.
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.
Include your API key in the Authorization header of every request:
Authorization: Bearer your_api_key_here
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 taskConfigure outgoing webhooks to receive real-time event notifications:
POST request with a JSON payload for each event.Every webhook payload includes:
{
"event": "contact.created",
"timestamp": "2026-03-22T10:30:00Z",
"data": {
"id": "uuid",
"full_name": "Jane Doe",
"email": "jane@example.com"
}
}
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.
Need more help? Ask Sally in the chat bubble!
Was this helpful?
Have more questions? Get instant answers.
Still need help? Our support team is here for you.
Contact Support