Integration with an HTTP API

Part 1: Setting Up Your HTTP API Integration

The first thing you'll need to do is set up your HTTP API integration in Ubico. This is a one-time setup that allows Ubico to communicate with your external API and use it across your workspace.

Step 1: Create the Integration

This is where you register your API inside Ubico.

1. Head over to Integrations in your Ubico dashboard
2. Click Add Integration and select HTTP API
3. Give your integration a descriptive Name so you can easily identify it later (e.g., My Enrichment API)
4. Enter your API Base URL (e.g., https://api.yourservice.com)

Step 2: Configure Custom Headers

Custom headers are used for authentication, request format and more.

5. Click Add Header and enter the key-value pairs required by your API
6. Click Save to complete the integration setup

Part 2: Adding a Custom HTTP API Enrichment Field

Now that your integration is connected, it's time to put it to work. Enrichment fields let you pull data from your API directly into your Ubico table.

Once your integration is set up, you can use it to enrich your table records with data from the API.

Step 1: Add an Enrichment Field

Here you're creating the actual column in your table that will hold the data coming in from your API.

1. Open the table where you want to add the enrichment
2. Click Add Enrichment and select Integration
3. Select HTTP API Integration

Step 2: Select Your Integration

Now you'll link the enrichment field to the HTTP API integration you just set up.

1. From the integration dropdown, select the HTTP API integration you just created

Step 3: Select the API Method

This step determines how Ubico communicates with your API. Different APIs work differently,

1. Choose the appropriate HTTP method

Step 4: Configure the Request Parameters (Optional)

This is where you tailor the request to fit your specific use case. You can pass data from your table directly into the API call.

1. If using a POST method, configure the request body
2. If using a GET method, configure query parameters
3. You can map fields from your table as dynamic variables (Using "/" command)

Step 5: Set Up an Auto-Trigger (Optional)

If you don't want to run enrichments manually every time, Auto-Trigger takes care of it for you. Once enabled, Ubico will automatically enrich new or updated records as soon as they hit your selected segment(s).

1. Enable Auto-Trigger if you want the enrichment to run automatically when a new record is added or updated to one or more segment
2. Configure the trigger conditions as needed

Step 6: Save and Complete

1. Review your enrichment field settings
2. Click Save to finish setup

Part 3: Running the Enrichment in Table Cells

Once the enrichment field is created, you can run it directly from your table.

1. Locate the custom enrichment column in your table
2. Click on a cell or select multiple rows
3. Click Run Enrichment to fetch data from the API
4. The results will populate automatically in the enrichment field column

Tip: Use auto-trigger to avoid running enrichments manually for every new record.