---
schema_version: "1"
id: fefb72487a741029d85c8e57d11a135def7850f38f3235708b90caaa569898d2
title: Custom HTTP Integrations in Agentforce Operations
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/automate_afsc_integrations_custom_http.md
canonical_url: https://help.salesforce.com/s/articleView?id=platform.automate_afsc_integrations_custom_http.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 40373c3d686f50bd2991f595ccf05fbc95ab4c80b4fbadc88f72698d3d203056
description: With Custom HTTP integrations Agentforce Operations can call HTTP APIs to exchange data with external systems during workflow execution. Use them to send workflow data to an API, get data from an API for use in a workflow, or search external datasets based on workflow parameters.
products:
  - Cross Cloud
release: "264"
---
# Custom HTTP Integrations in Agentforce Operations

With Custom HTTP integrations Agentforce Operations can call HTTP APIs to exchange data with external systems during workflow execution. Use them to send workflow data to an API, get data from an API for use in a workflow, or search external datasets based on workflow parameters.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
      <colgroup>
        <col>
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="colgroup" class="slds-cell-wrap" colspan="1" style="text-align:left;vertical-align:top;" id="d20781e37">License Required</th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="License Required" class="slds-cell-wrap" style="vertical-align:top;" headers="d20781e37 ">
            <p>This feature is a workspace that’s external to your Salesforce org and requires
              an Agentforce Operations license. </p>
            <p style="margin-bottom:0;">To purchase an Agentforce Operations license, contact your Salesforce account
              executive.</p>
          </td>

        </tr>
      </tbody>
    </table>

## Common Use Cases

Use custom HTTP integrations to:

- Notify an external API when a workflow starts in Agentforce Operations
- Send data from a running workflow to an API
- Get data from an API for use inside a workflow
- Search external datasets based on workflow parameters

Custom HTTP integrations support any data exchange except tabular data or paginated data. For tabular data, use a Workato integration.

## Request Configuration

Configure the outgoing request with these options:

- URL: The API endpoint URL. Supports query parameters populated from workflow fields or static values.
- Method: GET, POST, PUT, PATCH, or DELETE.
- Authentication: OAuth 2.0 or bearer token authentication.
- Headers: Add custom headers for log identification, authentication, cache control, and so on. Agentforce Operations automatically includes metadata headers about the workflow, stage, and task with every request.

## Payload Configuration

Agentforce Operations supports JSON and Form Data payloads for outgoing requests. To construct nested JSON, prefix the key field with a period.

For example, map `.childPayload.keyOne` to a text value to produce this nested JSON structure:

```
{
  "childPayload": {
    "keyOne": "valueOne"
  }
}
```

Different field types in Agentforce Operations produce different JSON structures in the request payload:

- Checkbox fields send boolean values (true or false)
- Date fields use ISO 8601 format
- People fields send email addresses

## Response Extraction

Agentforce Operations uses jq syntax to extract data from API responses. Map extracted values to Agentforce Operations fields that match the data type of the extracted data. The jq syntax supports complex and conditional extraction from JSON payloads.

For example, to extract the state abbreviation from a postal code lookup response, use: `.places[0]["state abbreviation"]`.

## Automatic Metadata Headers

Agentforce Operations automatically sends headers with metadata about the workflow, stage, and task that originated the request:

- `X-Regrello-WorkflowID`
- `X-Regrello-StageID`
- `X-Regrello-ActionItemTemplateID`
- `X-Regrello-ActionItemID`

## Learn More

To set up a Custom HTTP integration, see [Create a Custom HTTP Integration in Agentforce Operations](https://help.salesforce.com/s/articleView?id=platform.automate_afsc_integrations_custom_http_create.htm&release=264.0.0&type=5 "Create a Custom HTTP integration to connect Agentforce Operations to an external API. Use Custom HTTP integrations to send or retrieve data during workflow execution.").

- **[Create a Custom HTTP Integration in Agentforce Operations](https://help.salesforce.com/s/articleView?id=platform.automate_afsc_integrations_custom_http_create.htm&release=264.0.0&type=5)**  
    Create a Custom HTTP integration to connect Agentforce Operations to an external API. Use Custom HTTP integrations to send or retrieve data during workflow execution.
- **[Add a Custom HTTP Integration to a Blueprint in Agentforce Operations](https://help.salesforce.com/s/articleView?id=platform.automate_afsc_integrations_custom_http_blueprint.htm&release=264.0.0&type=5)**  
    Add a custom HTTP automation task to a blueprint stage to automatically send or retrieve data when a workflow reaches that stage.
- **[Example Simple Custom HTTP Integration in Agentforce Operations](https://help.salesforce.com/s/articleView?id=platform.automate_afsc_integrations_custom_http_example.htm&release=264.0.0&type=5)**  
    Walk through an end-to-end example of creating a custom HTTP integration that looks up city and state information for a US postal code, and then adding it to a blueprint as an automation task.