---
title: "External APIs"
slug: "external-apis"
updated: 2026-06-26T16:59:45Z
published: 2026-06-26T16:59:45Z
canonical: "docs.unqork.io/external-apis"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# External APIs

UDesignerClassic Designer

External APIs enable Creators to build versatile Centauri (v1.0) and Vega (v2.0) [applications](/v1/docs/introduction-to-unqork-applications) connecting to thousands of other services. For example, if you need to add a map feature to your application, you might use a Google Maps API. Doing so lets you avoid having to build the map yourself.

## About External APIs

Unqork lets Creators integrate external API services into environments. For example, connecting to a CRM (customer relationship management) system, or integrating with a Salesforce instance and DocuSign account.

Making an external API call requires a little extra work compared to an internal API call. First, set up the external service in [Services Administration](/v1/docs/services-administration). Then, configure the API with a [Plug-In](/v1/docs/plug-in-component) component to make the call.

> [!WARNING]
> **Payload limits for external service calls**:
> 
> - Outgoing request payload: 100 MB
> - Response size when **Expect Binary Response** is enabled: 2 GB

## Setting Up an External Service

To make an external API call, the first step is to set up the service in your Unqork environment. To set up that integration, you need four pieces of information:

| Setting | Description |
| --- | --- |
| **Service Title** | This title displays in the **External Services** drop-down in the [Plug-In](/v1/docs/plug-in-component) component. Typically, you use the name of the application or service. |
| **Service Name** | The Service Name is permanent. As a best practice, keep Service Names simple and avoid spaces. For example, you might use **googlemaps** when setting up a Google Maps integration. |
| **Service Protocol + Host** | This refers to the URI for all API calls made with this service. The URI serves as a locator, telling the API where to direct the call. If any part of the URI is consistent for every call, enter that part here. You can always add to the URI when configuring a specific API call. |
| **Type of Authentication** | This is the method of authentication the service or application uses. The service provider determines which method to use. If you're unsure of the authentication type, refer to the API service's documentation. |

These are not the only settings on the page, but they’re the minimum required for an external API call. In rare cases, Creators might need to specify certain Request Headers for all calls made using the API. Or, you might need to include certain items in each request body. For more details on each setting, visit the [Services Administration](/v1/docs/services-administration) article.

> Learn how to create and add a service in our [How To: Add a Service](/v1/docs/services-administration-how-to-add-a-service) article.

## How to Make an External API Call

For this example, set up a SendGrid API call to send emails automatically. In Unqork, you can trigger an API call to SendGrid based on end-user interaction. When an end-user clicks a button, it triggers an API call to SendGrid. Then, SendGrid sends the email.

> When configuring API calls, it's best practice to use a Proxy module. Because this example focuses on configuring the API call, you won't create a Proxy module. To learn more about setting up Proxy modules, see our [How to: Add a Proxy Module to a Remote Execute](/v1/docs/how-to-add-a-proxy-module-to-a-remote-execute) article.

## Preconfiguration

### Configure the External Service

First, configure the SendGrid service in [Services Administration](/v1/docs/services-administration). To get the necessary information, use SendGrid's API documentation: [https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html).

1. At the top right of the Unqork Designer Platform, click **Administration**.
2. Under Integration, click **Services Administration**.
3. Click **+ Add a Service**. The Create New Service modal displays.
4. In the **Service Title*** and **Service Name*** fields, enter `SendGrid`.
5. Click **Next**.
6. In the **Share To** field, specify if the service is shared with the Environment or a specific Workspace.
7. Click **Create**. The service page loads for the new service. The service can now be configured.
8. In the top right of the page, click **E****dit**.
9. From the left menu, click the **Service Type** button.
10. In the **Service Protocol + Host*** field, enter `https://api.sendgrid.com/v3`.
11. From the **Authentication Method*** drop-down, select **Bearer Token**.
12. In the **Bearer Token** field, enter your Bearer Token value.

> [!TIP]
> This Bearer Token is unique to every SendGrid user. The Unqork Training environment uses Unqork's SendGrid Bearer Token.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/serviceSendGrid_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)
13. Click **Save Changes**.

## Configuration

Configure a module to use the SendGrid API service. Set up an [Email](/v1/docs/email-component) and [Text Area](/v1/docs/text-area-component) component to contain an end-user's message, then send that data using the SendGrid API.

### Configure the Columns Component

This [Columns](/v1/docs/columns-component) component acts as a container to keep a module organized. You'll use the component to contain an [Email](/v1/docs/email-component) and [Text Area](/v1/docs/text-area-component) component.

1. In the Module Builder, drag and drop a **Columns** component onto your canvas.
2. In the Property ID field, enter `colEmail`.
3. Click **Save Component**.

### Configure the Email Component

This [Email](/v1/docs/email-component) component serves as the recipient of the email. In a later step, you'll map this to the SendGrid API call using a [Plug-In](/v1/docs/plug-in-component) component.

1. Drag and drop an **Email** component onto your canvas, placing it inside the left-hand column of the **colEmail** **Columns**.
2. In the **Property ID** field, enter `emailAddress`.
3. In the **Label Text** field, enter `Email Address`.
4. Click **Save Component**.

### Configure the Text Area Component

This [Text Area](/v1/docs/text-area-component) component serves as the body of the email. In the next step, map this to your API call using the [Plug-In](/v1/docs/plug-in-component) component.

1. Drag and drop a **Text Area** component onto your canvas, placing it inside the right-hand column of the **colEmail** **Columns** component.
2. In the **Property ID** field, enter `emailMessage`.
3. In the **Label Text** field, enter `Email Message`.
4. Click **Save Component**.

### Configure the Plug-In Component

Use a [Plug-In](/v1/docs/plug-in-component) component to map the data parameters into a single request body.

1. Drag and drop a Plug-In component onto your canvas, placing it below the **colEmail** **Columns** component.
2. In the **Property ID** field, enter **pluginSendEmail**
3. In the **Canvas Label Text** field, enter `pluginSendEmail`.
4. From the **Service Type** drop-down, select **External**.
5. From the **External Services** drop-down, select the Sendgrid service set up in the Pre-Configuration steps.
6. In the **Data Source URL** field, enter `mail/send`.
7. From the **Request Type** drop-down, select **Post**.

> [!NOTE]
> The **Service Protocol + Host**value entered earlier pre-populates here. This is consistent for any call made using SendGrid. Adding `mail/send` specifies that you are sending an email in this specific call.
8. In the **Inputs table**, enter the following:

| # | Property ID | Mapping |
| --- | --- | --- |
| 1 | emailAddress | personalizations[0].to[0].email |
| 2 | emailMessage | content[0].value |
| 3 | 'training@unqork.com' | from.email |
| 4 | ‘Hello Subject’ | subject |
| 5 | ‘text/html’ | content[0].type |

> [!NOTE]
> Setting any of these inputs as Required stops the API call from sending if the value is not present. Setting an input as Optional means the call sends without the parameter rather than as a blank value if that parameter is empty.

> [!NOTE]
> You can find the parameters for external API calls in the service's documentation. You need to include every required parameter for your call to succeed. You can find the SendGrid documentation here: [https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html).

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/pluginSendEmail_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)
9. Click **Save Component**.

### Configure the Button Component

Lastly, configure a [Button](/v1/docs/button-component) component to trigger your [Plug-In](/v1/docs/plug-in-component) component. When you click this button in Express View, the Plug-In component makes the API call.

1. Drag and drop a **Button** component onto your canvas, placing it between the **colEmail Columns** and **pluginSendEmail** **Plug-In** components.
2. In the **Property ID** field, enter `btnSendEmail`.
3. In the **Label Text** field, enter `Send Email`.
4. Navigate to the **Actions** settings.
5. From the **Action Type** drop-down, select **Event**.
6. In the **On Click** field, enter `plugSendEmail`.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/btnSendEmail_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)
7. Click **Save Component**.
8. **Save** your module.

Your completed module configuration looks like the following in the Module Builder:

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/moduleBuilderView_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)

Click **Preview** to test your configuration in Express View. Fill out the fields and click the **Send Email** button. If your call is successful, you'll receive an email at the email address you entered in Express View.![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/ExternalAPI_Express_01_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)

## Overview

External APIs enable Creators to build versatile [applications](/v1/docs/introduction-to-unqork-applications) connecting to thousands of other services. For example, if you need to add a map feature to your application, you might use a Google Maps API. Doing so lets you avoid having to build the map yourself.

## About External APIs

Unqork lets Creators integrate external API services into your environment that Unqork’s API doesn't already offer. For example, connecting to a CRM (customer relationship management) system, or integrating with a Salesforce instance and DocuSign account.

Making an external API call requires a little extra work compared to an internal API call. First, you need to set up the external service in [Services Administration](/v1/docs/services-administration). Then, to make the call, you need to configure the API with a [Plug-In](/v1/docs/plug-in-component) component.

> [!WARNING]
> **Payload limits for external service calls**:
> 
> - Outgoing request payload: 100 MB
> - Response size when **Expect Binary Response** is enabled: 2 GB

## Setting Up an External Service

To make an external API call, the first step is to set up the service in your Unqork environment. To set up that integration, you need four pieces of information:

| Setting | Description |
| --- | --- |
| **Service Title** | This title displays in the **External Services** drop-down in the [Plug-In](/v1/docs/plug-in-component) component. Typically, you use the name of the application or service. |
| **Service Name** | The Service Name is permanent. As a best practice, keep Service Names simple and avoid spaces. For example, you might use **googlemaps** when setting up a Google Maps integration. |
| **Service Protocol + Host** | This refers to the URI for all API calls made with this service. The URI serves as a locator, telling the API where to direct the call. If any part of the URI is consistent for every call, enter that part here. You can always add to the URI when configuring a specific API call. |
| **Type of Authentication** | This is the method of authentication the service or application uses. The service provider determines which method to use. If you're unsure of the authentication type, refer to the API service's documentation. |

These aren't the only settings on the page, but they’re the minimum you need for an external API call. In rare cases, you might need to specify certain Request Headers for all calls made using the API. Or, you might need to include certain items in each request body. For more details on each setting, visit the [Services Administration](/v1/docs/services-administration) article.

> Learn how to create and add a service in our [How To: Add a Service](/v1/docs/services-administration-how-to-add-a-service) article.

## How to Make an External API Call

For this example, you'll set up a SendGrid API call to send emails automatically. In Unqork, you can trigger an API call to SendGrid based on end-user interaction. When an end-user clicks a button, it triggers an API call to SendGrid. Then, SendGrid sends the email.

> When configuring API calls, it's best practice to use a Proxy module. Because this example focuses on configuring the API call, you won't create a Proxy module. To learn more about setting up Proxy modules, see our [How to: Add a Proxy Module to a Remote Execute](/v1/docs/how-to-add-a-proxy-module-to-a-remote-execute) article.

## Preconfiguration

### Configure the External Service

First, configure the SendGrid service in [Services Administration](/v1/docs/services-administration). To get the necessary information, use SendGrid's API documentation found here: [https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html). This is where you find the authentication method and information for the API call.

1. At the top right of the Unqork Designer Platform, click **Administration**.
2. Under Integration, click **Services Administration**.
3. Click **+ Add a Service**. The Create New Service modal displays.
4. In the **Service Title*** and **Service Name*** fields, enter `SendGrid`.
5. Click **Next**.
6. In the **Share To** field, specify if the service is shared with the Environment, or a specific Workspace.
7. Click **Create**. The service page loads for the new service. The service can now be configured.
8. In the top right of the page, click **E****dit**.
9. From the left menu, click the **Service Type** button.
10. In the **Service Protocol + Host*** field, enter `https://api.sendgrid.com/v3`.
11. From the **Authentication Method*** drop-down, select **Bearer Token**.
12. In the **Bearer Token** field, enter your Bearer Token.

> [!NOTE]
> This Bearer Token is unique to every SendGrid user. The Unqork Training environment uses Unqork's SendGrid Bearer Token.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/serviceSendGrid_thumb_0_0(1).jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)
13. Click **Save Changes**.

## Configuration

With your service configured, open your module to finish the configuration to make a SendGrid API call.

### Configure the Columns Component

This [Columns](/v1/docs/columns-component) component acts as container to keep the module organized. Use the component to contain an [Email](/v1/docs/email-component) and [Text Area](/v1/docs/text-area-component) component.

1. In the Module Builder, drag and drop a **Columns** component onto your canvas.
2. In the Property ID field, enter **colEmail**.
3. Click **Save & Close**.

### Configure the Email Component

This [Email](/v1/docs/email-component) component serves as the recipient of your email. In a later step, you'll map this to the API call using a [Plug-In](/v1/docs/plug-in-component) component.

1. Drag and drop an **Email** component onto your canvas, placing it inside the left-hand column of the **colEmail** **Columns** component.
2. In the Property ID field, enter **emailAddress**.
3. In the Label Text field, enter `Email Address`.
4. Click **Save & Close**.

### Configure the Text Area Component

This [Text Area](/v1/docs/text-area-component) component serves as the body of the email. In the next step, you'll map this to the API call using the [Plug-In](/v1/docs/plug-in-component) component.

1. Drag and drop a **Text Area** component onto your canvas, placing it inside the right-hand column of the **colEmail** **Columns** component.
2. In the Property ID field, enter **emailMessage**.
3. In the Label Text field, enter `Email Message`.
4. Click **Save & Close**.

### Configure the Plug-In Component

Use a [Plug-In](/v1/docs/plug-in-component) component to map the parameters into a single request body.

1. Drag and drop a Plug-In component onto your canvas, placing it below the **colEmail** **Columns** component.
2. In the **Property ID** and Canvas Label Text fields, enter `pluginSendEmail`.
3. From the **Service Type** chips, select External.
4. From the **External Services** drop-down, select the Sendgrid service set up in the Pre-Configuration steps.
5. In the **Data Source URL** field, enter mail/send.
6. From the **Request Type** chips, select Post .

> [!NOTE]
> The Service Protocol + Host you entered earlier prepopulates here. That is consistent for any call made using SendGrid. Adding mail/send specifies that you are sending an email in this specific call.
7. In the **INPUTS** table, enter the following:

| Property ID | Mapping |
| --- | --- |
| emailAddress | personalizations[0].to[0].email |
| emailMessage | content[0].value |
| 'training@unqork.com' | from.email |
| ‘Hello Subject’ | subject |
| ‘text/html’ | content[0].type |

> [!NOTE]
> Setting any of these inputs as Required stops the API call from sending if the value is not present. Setting an input as Optional means the call sends without the parameter rather than as a blank value if that parameter is empty.

> [!NOTE]
> You can find the parameters for external API calls in the service's documentation. You need to include every required parameter for your call to succeed. You can find the SendGrid documentation here: [https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html).

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/APIs_ExternalAPIs_Plugin_01_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)
8. Click Save.

### Configure the Button Component

Finally, configure a [Button](/v1/docs/button-component) component to trigger your [Plug-In](/v1/docs/plug-in-component) component. When you click this button, the Plug-In sends the API call.

1. Drag and drop a **Button** component onto your canvas, placing it between the **colEmail** **Columns** and **pluginSendEmail** Plug-In components.
2. In the Property ID field, enter **btnSendEmail**.
3. In the Label Text field, enter `Send Email`.
4. To the left of the component's configuration window, click **Actions**.
5. From the **Action Type** chips, select **Event**.
6. In the **On Click** field, select or enter **pluginSendEmail**.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/APIs_ExternalAPIs_Button_03_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)
7. Click **Save & Close**.
8. **Save** your module.

Your completed module configuration looks like the following in the Module Builder:

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/moduleBuilderClassic_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)

Click **Preview** to test your configuration in Express View. Fill out the fields and click the **Send Email** button. If your call is successful, you'll receive an email at the email address you entered in Express View.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/ExternalAPI_Express_01_thumb_0_0(1).jpg?sv=2026-02-06&spr=https&st=2026-11-11T02%3A57%3A42Z&se=2026-11-11T03%3A57%3A42Z&sr=c&sp=r&sig=%2BnME9%2BzoQe4J0Ej0x64cDaN%2BlDTMfzO18FvlF%2FXEACI%3D)

## Resources

- [APIs: Connecting Your Apps](/v1/docs/apis-connecting-your-apps)
- [Services Administration](/v1/docs/services-administration)
- [Authentication Types](/v1/docs/authentication-types)
- [Plug-In Component](/v1/docs/plug-in-component)

APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

The Centauri (v 1.0.0) runtime is the first-generation foundation of the Unqork Designer Platform. Centauri provides Creators a codeless experience for developing applications.

The Vega (v 2.0.0) runtime is the next-generation engine of the UDesigner platform. Vega uses cutting-edge technologies to improve the Creator and end-user experience.

Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.

APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.

URI (Uniform Resource Identifier) identifies a resource by name, location, or both.

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the .