> For the complete documentation index, see [llms.txt](https://guides.clickatell.com/flow/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guides.clickatell.com/flow/workflow-management/create-new-flow/dynamic-api-workflows.md).

# Dynamic API Workflows

Dynamic API workflow is a custom Chat Flow channel. It enables external systems to trigger Chat Flow workflows through incoming payloads. It provides a workflow-first approach to customer engagement by allowing businesses to initiate conversations, inject business data, and automate customer journeys based on real-time business events.

\
Dynamic API is designed to orchestrate conversational workflows within Chat Flow. It acts as the entry point into workflow automation, allowing enterprise systems to initiate and manage customer engagements programmatically.

To set up a Dynamic API workflow, see [our how-to guide](https://help.clickatell.com/developers-documentation/dynamic-api-to-trigger-chat-flow-workflows).

{% hint style="info" %}
Note that a Dynamic API workflow has no access to user facing nodes because it is an API builder.
{% endhint %}

#### **Key Capabilities**

\
• Trigger Chat Flow workflows from external systems.
\
• Initiate customer engagements programmatically.
\
• Orchestrate complete conversation lifecycles within Chat Flow.
\
• Support both synchronous and asynchronous processing models.
\
• Generate unique endpoint URLs and API tokens for individual routes.
\
• Send pre-approved WhatsApp templates using the Send Template node.
\
• Enable event-driven customer journeys based on business events and external system activity.

#### **How Dynamic API Fits Into Chat Flow**

\
• Trigger workflow execution.
\
• Inject contextual business data.
\
• Initiate customer engagements.
\
• Drive conversation paths based on real-time business events.

\
This makes Dynamic API the orchestration layer for automated, event-driven customer engagement journeys while Chat Flow manages the customer interaction experience.

### Dynamic API Design Principles

* **Workflow-First Integration Model**

Dynamic API is designed to trigger and orchestrate Chat Flow workflows rather than send messages directly. All customer interactions are executed within the context of a defined conversational journey. Dynamic API workflows are built as workflow entry points and are API-driven by design.

* **Event-Driven Engagement Initiation**

External systems initiate engagements by sending payloads to Dynamic API endpoints. This enables real-time customer conversations and automated business workflows that can respond immediately to external events.

* **Route-Based API Architecture**

Each Dynamic API integration is configured as a route within Chat Flow. Every route provides a unique endpoint URL, a route-specific API token, configurable HTTP methods, and configurable access controls.

* **Support for Synchronous and Asynchronous Processing**

Dynamic API supports both synchronous and asynchronous execution models. Synchronous processing follows a request-response pattern, while asynchronous processing provides acknowledgement-based processing without detailed workflow execution feedback.

* **Template-Driven Conversation Initiation**

Dynamic API enables businesses to initiate customer conversations using pre-approved WhatsApp message templates through the Send Template node. This supports proactive engagement while helping businesses remain aligned with WhatsApp messaging requirements.

* **Separation of Integration Logic and Customer Journeys**

Dynamic API workflows are designed as API-driven orchestration layers. This creates a clear separation between integration logic, such as external system triggers and data injection, and customer-facing conversational journeys.

* **Secure Access Model**

Dynamic API provides enterprise-grade access controls through route-specific API tokens, IP allowed listing, controlled endpoint exposure, and configurable route-level access restrictions.

* **Environment-Based Deployment**

Dynamic API supports separate environments for testing and live workflow execution. This aligns with standard enterprise development, validation, and release-management practices.