Developer Tools

Webhooks Integration

Design. Customize. Export Stunning Gradients. Connect your workflow to real-time event notifications.

Configure Your Endpoint View Event Catalog

Event Types

ChromaFlow dispatches structured payloads whenever critical design actions occur across your workspace. Subscribe to these events to sync your asset library, trigger CI/CD pipelines, or notify Slack channels.

gradient.saved

Gradient Creation & Updates

Fires when a designer saves a new gradient or modifies an existing one. Includes color stops, blend modes, and hex/RGB values for projects like the "Aurora Borealis" collection or "Midnight Synthwave" palette.

palette.shared

Collaboration & Distribution

Triggers when a gradient pack is published to a public link or shared with a specific team channel. Useful for updating your design system documentation or notifying stakeholders at Nexus Studios.

team.role.changed

Workspace Permissions

Dispatched when administrator privileges are granted or revoked. Helps maintain audit logs for compliance and automatically provisions access to external color management APIs.

export.completed

Asset Generation

Emitted after a batch export finishes. Reports file formats (CSS, SCSS, JSON), compression ratios, and download URLs for seamless handoff to frontend developers.

Payload Structure

Every webhook POST request uses JSON format with a consistent envelope. ChromaFlow signs each payload using HMAC-SHA256 to verify authenticity before your server processes the data.

Request Headers

Authentication & Validation

Include X-ChromaFlow-Signature and X-ChromaFlow-Event headers. Validate the timestamp against your server clock to prevent replay attacks. Retry logic follows an exponential backoff pattern up to five attempts.

JSON Envelope

Standardized Data Schema

Each payload contains a unique event_id, occurred_at ISO timestamp, and a data object. For gradient updates, the data object exposes stops, direction, and workspace_id fields ready for database ingestion.

Error Handling

Delivery Guarantees

Return HTTP 200–299 to acknowledge receipt. Non-2xx responses trigger automatic retries. Monitor delivery status through the ChromaFlow dashboard or query the /webhooks/logs endpoint for failed payloads.

Setup Guide

Connect your backend to ChromaFlow in three minutes. Follow these steps to register your endpoint, verify the connection, and start receiving real-time gradient events.

Step 1

Generate an API Secret

Navigate to Settings > Developer > Webhooks in your ChromaFlow dashboard. Click "Create New Secret" to generate a 64-character HMAC key. Store this securely in your environment variables before proceeding.

Step 2

Register Your Endpoint

Enter your HTTPS callback URL and select the events you want to monitor. We recommend starting with gradient.saved and export.completed while building your integration pipeline.

Step 3

Verify & Activate

Submit the form to trigger a test payload. Your server must respond with a 200 status within three seconds. Once verified, the webhook moves to "Active" status and begins streaming live events.

Need help parsing the JSON body or configuring SSL certificates? Our engineering team maintains a public GitHub repository with SDK examples for Node.js, Python, and Go. Check the documentation portal or reach out to developer support at integrations@chromaflow.design.

Open Webhook Dashboard Download SDK Examples