# Integrations

### What is a Pipe?

A Pipe is a single integration unit, i.e., the sub-unit of every system integration, responsible for synchronizing all entities (Customers, Orders, Products, etc.). Each pipe is mapped to a Flow to carry out the underlying integration logic.

For a quick video explainer of What are Pipes?, [click here. ](https://www.youtube.com/watch?v=Bo2KymVaLHk)

<figure><img src="/files/WJ7WC01dtXsUgtgy3Xst" alt=""><figcaption></figcaption></figure>

### **Pipe Types**

#### Batch ![](https://lh5.googleusercontent.com/kXOx0IqyBOi1PlWrP0nTLdsIONPDzdqbmAoN8g-4dMS0HAW03yoqKoZpmm2OgqNPJzgDP9Msm4OlWl9vovciMYAk2WjGyOLn0zi3QYcIWfgn0iXGGLy5Q8YuVRAzru-xqPSLmxqd)

Data synchronization will be handled periodically at certain configured time intervals. This is the most commonly used Pipe type since it offers optimum performance.&#x20;

> *Example: Every 2 hours*&#x20;

#### Dynamic ![](https://lh3.googleusercontent.com/KStYMLew0pT1Ut2aekVjwQjEFI_yazpAz7ncASPeyB9tR4d8t0ucb8piQNTz4UdQSKveChy-ES4dhVEMkoqjKo01K9qHLyuB531hnrwQ4zQQIVRU-pLfBSdj8tDjYZVGwO94hVlb)

Data synchronization is done in real-time using an API call from any system through DCKAP Integrator. For example, services like Pricing may be configured as a Dynamic Pipe to fetch the prices in real-time.

{% hint style="warning" %}
Use the following URL to run all your dynamic services in integrator.dckap.com:

<https://lightning.dckap.com/v1/dynamic/listener/{pipe_id}>

This URL can also be got by clicking on the ***COPY URL*** button in the Integrations page.&#x20;
{% endhint %}

{% hint style="info" %}
During a dynamic call to V3 or lightning, 400 and 401 Status codes will be returned for a disabled pipe and invalid credentials respectively.

For all other errors, 200 Status code will be returned.
{% endhint %}

{% hint style="info" %}
During dynamic calls, it is possible to authorize DCKAP Integrator by using access\_token, jwt\_token in headers/params.

Examples:&#x20;

<http://lightning.dckap.com/v1/dynamic/listener/\\><id>?access\_token=\<token>

<http://lightning.dckap.com/v1/dynamic/listener/\\><id>?token=\<jwt\_token>
{% endhint %}

### Manage Pipes

The pipes are displayed either as a Grid or a table.&#x20;

![Integrations displayed as a Grid](/files/M64iorm9cPxqUQN89Oqo)

![Integrations displayed as a List](/files/so5THXNnzIQJkmnH7MAx)

In the Integrations page, the following information is present in grid/tabular form:&#x20;

| Field Name                                                                | Sample                                                                                                                                                                                                                                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                           |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Status                                                                    | ![](https://lh4.googleusercontent.com/ZzVVFGJVkHSea5oRZcC59MIJ0KMsrwqs9caW7qPOLdzr4UvOdVW1AkZZuxKaW46s3sazTWjXSF_YiHXsckWW3hyrihq4WKOA8HFwa61TaQCwO39aXKgOiWRfjM316eRch1lE8Ffh)                                                                                                                                                                                                                                       | Enables or disables the working of a pipe, used especially during scheduled synchronization                                                                                                                                                                           |
| Pipe Name                                                                 | ![](https://lh6.googleusercontent.com/x3DAtICublO3TdU1qdQuujmTZ_CfiCKZ6bwvIwhxmH0F7bVIljFQu9_ra8loreeCHVbfXWChwQplenTNSOEm5um6QO2FVUpNJWaHt-xzWYILGaFZChjbhbc2lIpNhuTK5YOtytOd)                                                                                                                                                                                                                                       | Displays the name of Integration Pipe                                                                                                                                                                                                                                 |
| Systems                                                                   | ![](/files/-M50mpWe0kze4E0ExjgT)                                                                                                                                                                                                                                                                                                                                                                                      | <p>Systems connected in the pipe<br></p>                                                                                                                                                                                                                              |
| Type of Integration                                                       | <p><img src="https://lh5.googleusercontent.com/kXOx0IqyBOi1PlWrP0nTLdsIONPDzdqbmAoN8g-4dMS0HAW03yoqKoZpmm2OgqNPJzgDP9Msm4OlWl9vovciMYAk2WjGyOLn0zi3QYcIWfgn0iXGGLy5Q8YuVRAzru-xqPSLmxqd" alt="">Batch </p><p><img src="https://lh3.googleusercontent.com/KStYMLew0pT1Ut2aekVjwQjEFI_yazpAz7ncASPeyB9tR4d8t0ucb8piQNTz4UdQSKveChy-ES4dhVEMkoqjKo01K9qHLyuB531hnrwQ4zQQIVRU-pLfBSdj8tDjYZVGwO94hVlb" alt="">Dynamic</p> | <ul><li><strong>Batch</strong>: When the data synchronization is done periodically </li><li><strong>Dynamic</strong>: When the data synchronization is done in real-time using an API call to the system</li></ul>                                                    |
| Sync status                                                               | <img src="https://lh4.googleusercontent.com/OBFCcRxKiZIfNxonzS4GwHwB8XmMcFb41SS2Dpcj05OJaRjeFvfCNPKOMS4GpvW_TI5YZg1sgo0v98aIDgkezGyLjg5SbKgZ61HdDd1KbgKX8J_dkXttQoiBRYd3ZfnhtOQhUPzm" alt="" data-size="original">                                                                                                                                                                                                    | Displays the time at which the last sync was performed and if the sync was complete or not                                                                                                                                                                            |
| <p><strong>Sync Now</strong> &</p><p><strong>Copy URL</strong> button</p> | <p><img src="/files/-M50mw1V8KLbm7UJVTFe" alt="" data-size="original"></p><p><img src="/files/-M50mxwSvXFWxKw628dn" alt="" data-size="original"></p>                                                                                                                                                                                                                                                                  | <p>For Batch type Integration ⇒ Start the integration process by manually clicking on the <strong>Sync Now</strong> button. <br></p><p>For Dynamic type Integration ⇒ <strong>Copy URL</strong> and share across different systems to access data from the system</p> |
| View Logs                                                                 | ![](https://lh3.googleusercontent.com/CnlGBD66Aw-qslPITVXm3Z9p4KXF6DX9-hzh1zFSk1pMlDVyBp2iJGiJ-tVdc_py2mLN9MCNlyfnbDvWLAzPTQu_Xl9b4yx8tYYoF_biFlZXqPoRVSLRt8XiX4Rn1ZuYk8jRpGPX)                                                                                                                                                                                                                                       | To view Logs of this pipe                                                                                                                                                                                                                                             |
| Enable/Disable Autopilot Mode                                             | <p><img src="/files/-M50nAa3NPRETd6YERn3" alt=""></p><p><img src="https://lh5.googleusercontent.com/szRw2c9WKuI-qj8l7bfPgRCF16VWcyHILgBXQsTSmlIFXFBx0CzHDcXV0Z6Vhcp8SvxEi_6pgWe5TxN0R2KhL-4pWnfAygtFVkjv1v-ZNWuN0fLFtAFVdPKnKT3P0rP7O5Dforbt" alt=""></p>                                                                                                                                                             | <p>Only for Batch type Integration. To enable or disable Autopilot mode.<br></p><p>For Dynamic pipe, scheduling is disabled.</p>                                                                                                                                      |
| Enable/Disable Console Logs                                               | <img src="/files/-M50n46232GM7PIANrFp" alt="" data-size="original">                                                                                                                                                                                                                                                                                                                                                   | To enable or disable console logs for this Integration                                                                                                                                                                                                                |

### Auto Pilot Mode and Scheduler

The Sync process for Batch type integration can be automated by scheduling it. This is done by clicking on the **Enable Auto Mode** link present just below the pipe name or clicking the ![](https://lh4.googleusercontent.com/JVzohu9PTtDH4S4N_bWS3Rg8V8zZas4uoxc8TTB-tkCuN5MyJnZxwpmj4J3pDqZxKm7Z652r72b2ypFkC-_PTe7opIVcpAWDFhN1pT_QMuANThR_oxBdz0Smhlm_vH1w4kTGHgCY)icon and then editing the synchronization time. The Minimum Interval Period for scheduling is 5 minutes

![](/files/-M4ScXP8fmcRPGbOLILc)

{% hint style="danger" %}
For a Dynamic pipe,  the ability to schedule is disabled
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.dckapintegrator.com/project-manager/integrations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.