> For the complete documentation index, see [llms.txt](https://docs.bdb.ai/data-pipeline/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bdb.ai/data-pipeline/components/consumers/api-ingestion-and-webhook-listener.md).

# API Ingestion and Webhook Listener

**API ingestion** and **Webhooks** are two methods used to receive data from a third-party service or system.

All component configurations are classified broadly into 3 section

* [​Basic Information​](/data-pipeline/components/component-base-configuration.md)​
* Meta Information
* [Resource Configuration​](/data-pipeline/components/resource-configuration.md)​

{% hint style="success" %}
*Follow the steps given in the demonstration to configure the API Ingestion component.*
{% endhint %}

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2F1jxAWvr8kOWa7pSoXzJV%2F2023-03-29-13-04-37%20(online-video-cutter.com)%20(1).mp4?alt=media&token=708dcf66-f69b-4d90-ab27-b31bc5462707>" %}
Configuring the API Ingestion component with API ingestion selected as Ingestion Type
{% endembed %}

## ***Configure the Meta Information tab of API Ingestion Component***

<figure><img src="https://363587200-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2FabeJZWKq952eg4IEJxme%2Fimage.png?alt=media&amp;token=f36e827b-3741-460c-9274-0ece32861f08" alt=""><figcaption></figcaption></figure>

* Ingestion type: Select API ingestion as ingestion type from drop down.
* Ingestion Id: It will be predefined in the component.
* Ingestion Secret: It will be predefined in the component.
* Click on save component icon ![](https://363587200-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2F0mfvpm194seAaBWgfQRq%2Fimage.png?alt=media\&token=9b59e3e5-9f61-48cf-b96f-044601758703)to save the component.
* Click on save pipeline icon ![](https://363587200-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2FZlUkNxS8OtiOoxbp3rTL%2Fimage.png?alt=media\&token=793fcac8-0a79-4144-8caf-3a82c42e1b33) to save the pipeline.
* Once the pipeline gets saved, the ***Component Instance Id URL*** gets generated in the meta information tab of the component as shown in the above image.
* Connect a out event with the component and activate the pipeline.
* Open the Postman tool.
* Create a new request and select the **POST** as request method from drop down and provide the generated ***Component Instance Id URL*** in the URL section of the Postman tool.
* Navigate to the ***Headers*** section in the ***Postman*** tool and provide the Ingestion Id and Ingestion Section which is pre-defined in the ***Meta Information*** of the ***API Ingestion*** component.
* Navigate to the ***Body*** section in the ***Postman*** and select raw tab and select the JSON option from the drop-down as the data type.
* Now, enter the JSON data in the space provided and click on send button.
* The API Ingestion component will process the JSON data entered in the ***Postman*** tool and it will send the JSON data to the out event.

{% hint style="info" %}
*Please refer the below-given image to configure the Postman tool for **API Ingestion** component:*
{% endhint %}

<figure><img src="https://363587200-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuq3RSHHup7fjHYaspk7y%2Fuploads%2FOJ9CnzqDs8kFHfQjs5vc%2Fimage.png?alt=media&amp;token=31a3d7fa-972b-4cc7-9b8c-6c77734d55b3" alt=""><figcaption><p>Configuring the Postman tool for API Ingestion </p></figcaption></figure>