HTTP Callout V2
Use the HTTP Callout activity to invoke external APIs and connect the Conga Advantage Platform with third-party systems. After you configure the activity, you can use its output in the next activities. Select the required fields using the resource picker (constants, activity outputs, and variables). The resource picker (IntelliSense dropdown control) allows you to expand the response, navigate nested objects, and select the required values directly from the prepopulated workflow resource options available in the IntelliSense dropdown control.
Group: API Interactions
Sample Resource Picker (IntelliSense Dropdown):
Prerequisite
Setup Authentication Credentials: You must register the external endpoint through the External Endpoint Auth Credentials. Each endpoint configuration requires a unique name, which appears in the activity dropdown, and supports the following authentication types: OAuth2_Client_Credentials, OAuth2_Password, and BasicAuth.
- The Validate API generates the schema required for IntelliSense and metadata.POST and PUT requests require a RequestBody, while other methods can have a null RequestBody.
- The generated schema must be passed along with parameters such as Endpoint Auth Name, Payload, Headers, Route Parameters, and Query Parameters.
- Metadata fields enforce strict data types, supporting String, Identifier, Boolean, Int, Double, Decimal, DateTime, Object, and Array.
- IsCollectionOutput and OutputDataType are auto-generated from the schema and drive data transformation for single or bulk JSON records.
{
"RequestBodyMetadata": {
"Name": "Root",
"Type": "Object",
"Properties": {
"Name": { "Type": "String", "Example": "Record1" },
"Account": {
"Type": "Object",
"Properties": {
"Name": { "Type": "String", "Example": "Conga" }
}
}
}
},
"ResponseBodyMetadata": {
"Name": "Root",
"Type": "Object",
"Properties": {
"Success": { "Type": "Boolean", "Example": true },
"Data": {
"Type": "Object",
"Properties": {
"Id": { "Type": "String", "Example": "f5e5857a-d27a-42b6-8291-874b158e5f87" }
}
}
}
}
}
Execution Flow
When the workflow reaches this activity, it performs the following steps:
- Prepare the Request: When the workflow reaches this activity, it retrieves the endpoint details, including the URL, HTTP method, query parameters, headers, and authentication type, from the External Endpoint Configuration. It fills any placeholders in the URL, query parameters, and headers with the values you provide, if applicable. It securely applies the required credentials from the secret management system before sending the request.
- Send the Request : The activity sends the configured HTTP request to the external service and waits for the API response.
- Store the Response : After receiving the response, the activity stores it as structured activity output.
- Use the Activity Output: You can access this output in subsequent workflow steps using resource pickers (constants, activity outputs, and variables) with IntelliSense. Expand the activity output to view the full response hierarchy and select required fields directly in expressions, criteria, or activity inputs.
Properties, Entry Criteria and activity information
Properties represent the values used to perform the operations of an activity.
|
Field |
Description |
|---|---|
| Details | |
Display Name |
The friendly name of the activity. This is what you will see in the workflow canvas. |
Reference Name | The unique technical name of the activity within the workflow. This name identifies the activity output in subsequent workflow steps. The reference name appears under Activity Outputs in the IntelliSense resource picker.
|
Description | An optional field where you can enter a custom description for the activity. This helps explain its purpose to other users configuring the workflow. |
| Properties | |
|
Endpoint Config |
Dropdown list of available endpoint configurations. These are defined in the External Endpoint Config API and include details like authentication, request schema, and response schema. When you select an endpoint, the system automatically populates related values such as URL, Method, and Auth Config. |
|
URL |
Displays the API endpoint URL defined in the selected Endpoint Config. Route parameters are shown in curly braces ( |
|
Method |
The HTTP method associated with the selected endpoint (for example, GET, POST, PUT, PATCH, DELETE). |
|
Content |
The request body (typically in JSON format) for POST or PUT methods. Supports dynamic data from workflow variables. |
Auth Config | Shows the authentication configuration name linked to the endpoint. This is retrieved from the ExternalEndpointConfig setup. |
| Request Configuration Tabs | |
|
Body |
Defines the request body for methods such as POST and PUT. Supports JSON objects, arrays, or other valid request formats as defined in the endpoint schema. Leave empty for request types (like GET) that do not require a body. |
Headers | Defines the HTTP headers that must be included in the request. These vary depending on the external API you are integrating with. You can enter values manually, map them to workflow variables, or assign them dynamically using formulas. Custom headers can also be added using the Add button. For example, API-specific headers: as documented by the external service. |
Query Parameters | Allows you to define additional query string parameters that are appended to the URL. Custom query parameters can be added if required. |
Route Parameters | Displays the parameters defined in the endpoint URL. Each parameter can be mapped to a static value or to a workflow variable. You can also add optional route parameters as needed. For example, in the endpoint URL: {ObjectName} is a route parameter that you can replace with a specific object name, such as Account or Opportunity.). |