HTTP Callout

Use the HTTP Callout activity to invoke external APIs and connect the Conga Advantage Platform with third-party systems. This activity enables secure data exchange by dynamically sending workflow data to external APIs and handling conditional logic based on API responses in subsequent workflow steps.

Note: This activity is planned for deprecation in a future release. It is recommended to Use HTTP Callout Activity V2 for all new implementations.

Prerequisite: External API endpoints must be whitelisted within Conga's secret management service. To initiate the whitelisting process, contact your Conga representative.

Minimum information required for whitelisting an External API:


Authentication Type	Field Name	Description
OAuth2 Client Credentials	AuthURL	Authorization endpoint for OAuth2.
	ClientId	The client ID issued by the authorization server.
	ClientSecret	The secret key associated with the client ID.
	Scope	The permissions required for the API call.
OAuth2 Password Credentials	AuthURL	Authorization endpoint for OAuth2.
	ClientId	The client ID issued by the authorization server.
	ClientSecret	The secret key associated with the client ID.
Basic Authentication	UserName	The username required for authentication.
Basic Authentication	Password	The password associated with the username.

Properties, Entry Criteria and activity information

Properties represent the values used to perform the operations of an activity and Entry Criteria serve as conditions that determine whether an activity should be executed.


Field	Description
Details
Display Name	The user-friendly name of the activity, used to identify the HTTP Callout step in the workflow.
Reference Name	A unique technical identifier used in the workflow configuration. If left blank, the system auto-generates one based on the Display Name (removing special characters, spaces, and using underscores to join words).
Description	A brief explanation of the HTTP Callout activity's purpose.
Properties
External Services	Select the external service connection configuration that stores credentials (OAuth2, Basic Auth) and endpoints.
URL	The target API endpoint. You can use dynamic workflow data to parameterize this URL.
Method	Choose the HTTP method based on the type of operation you want to perform: GET – Retrieves data from the external system without modifying it. POST – Sends new data to the external system, typically to create a new resource. PUT – Replaces an existing resource with the data you send. Use this when you want to update the entire record. PATCH – Updates specific fields of an existing resource. Use this for partial updates. DELETE – Removes a resource from the external system.
Content	The request body (typically in JSON format) for POST or PUT methods. Supports dynamic data from workflow variables.
Request Headers	Add custom headers for the API request. Name: Header name (e.g., Authorization, Content-Type). Value: Corresponding value. Supports dynamic data from workflow variables. Add: Add multiple headers as needed.
Query Params	Define query parameters for the API call. Name: Parameter name (e.g., id, status) Value: Parameter value. Supports dynamic workflow variables. Add: Add multiple parameters if needed.
Output
Activity Output	Specifies the variable that stores the API response for use in later workflow activities. For new activities or when no output value is defined, this field is hidden. The system automatically uses the Reference Name as the output variable. If an output value already exists, the field is visible but read-only. The system continues to use the existing Activity Output value, which you can view but not edit.
Is Collection	Select this checkbox if the variable contains a collection of values, such as a list or array. Leave it unchecked if the variable holds a single value. This helps the system determine how to process the data, especially during transformations or when passing data between activities.
Variable Data Type	Use this dropdown to specify the format or structure of the variable's data. Currently, only JSON is supported. Ensures the system interprets and processes the data correctly based on its structure.

Use Case: Delete Salesforce Opportunity After Contract Cancellation

Business Context

When a contract is canceled, any associated Salesforce Opportunity becomes invalid and should be removed to keep the sales pipeline accurate. Automating this cleanup avoids manual effort, prevents reporting inaccuracies, and ensures the pipeline reflects only active, viable opportunities.

Overview

This use case guides administrators on configuring a Conga Workflow that automatically deletes the Salesforce Opportunity linked to a contract once its status changes to Canceled. The workflow uses a record‑trigger event, an email notification activity, and an HTTP Callout to the Salesforce API. Required inputs include Salesforce API credentials and the Opportunity ID stored on the contract.

Scenario

When a contract's Status is updated to Canceled, the workflow triggers automatically. It first sends an email notification to the assigned sales representative, informing them that the contract has been canceled and the related Opportunity will be removed. Then, using a configured external service, the workflow performs an API call to Salesforce to delete the Opportunity associated with the contract record. This ensures the sales pipeline remains clean without requiring manual intervention.

Prerequisites

Salesforce API credentials: Client ID, Client Secret, Access Token, and Endpoint URL.
The Opportunity ID is available on the Contract record (e.g., Contract.OpportunityID__c).
The Contract Status field includes a clearly defined Canceled status value.

Create the Workflow. To learn how to create a workflow, see Creating Workflows topic. Enter the following sample data:


Details
Name	Delete_Salesforce_Opportunity_On_Cancellation
Display Name	Delete Salesforce Opportunity
Description:	Deletes the related Salesforce Opportunity when a contract is canceled.
Workflow Type
Workflow Type	Standalone Workflow
Trigger	Record Trigger
Object Name	Agreement
Trigger Info
Display Name	Contract Canceled Trigger
Reference Name	contractCanceledTrigger
Description	Trigger the workflow when a contract is canceled.
Action Type	Delete
Trigger Condition for Update	Field: Status Operator: Equals Value: Canceled

The workflow is created in Draft status with one DataChangeWorkflowTriggerActivity.

Add a Send Email Activity to send an automated email to the assigned sales representative. To learn more, see Send Email topic. Enter the following sample data:


Details
Display Name	Notify Sales Rep on Cancellation
Reference Name	notifySalesRep
Description	Notify that the contract has been canceled and the associated opportunity will be deleted.
Properties
Recipient Type	User
To Address	Assigned Sales Representative's email ID.
Subject	Contract {{Workflow.Context.Record.Name}} Canceled
Body	Click the three-dot icon in the corner and select Expression as the body type to use the following Liquid expression. `Hello, The contract {{Workflow.Context.Record.Name}} has been canceled. As a result, the associated opportunity in Salesforce will be deleted automatically. Regards, Contract Management System`

An EmailActivity is added to the workflow.

Add HTTP Callout Activity. To learn more, see HTTP Callout topic. Enter the following sample data:


Details
Display Name	Delete Opportunity in Salesforce
Reference Name	deleteOpportunityAPI
Description	Uses Salesforce API to delete the linked Opportunity upon contract cancellation.
Properties
External Services	Select the whitelisted external authentication service.
URL	https://<instance>.salesforce.com/services/data/vXX.X/sobjects/Opportunity/{{Workflow.Variables.OpportunityID}} Note:Replace `<instance>` with your Salesforce instance and `vXX.X` with the API version number.
Method	DELETE

An HttptCalloutActivity is added to the workflow.

After all activities are configured and tested, publish the workflow to make it active.

When a contract is canceled:

An email notification is sent to the assigned sales representative.
The linked Salesforce Opportunity is automatically deleted using the Opportunity ID.

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

HTTP Callout

Use Case: Delete Salesforce Opportunity After Contract Cancellation

Footer Section

Explore