Edwin AI Outbound HTTP Request Integration

The HTTP Endpoint integration enables Edwin AI workflows to send outbound HTTP requests to external systems using the Perform HTTP Request action. This integration is commonly used to integrate with custom APIs.

HTTP Request Response Mapping

When Edwin AI receives a response from an external system, it attempts to parse the payload as JSON and map the returned values for use within the platform.

Edwin AI looks for a top-level id field in the JSON response. If an id field is present, its value is used as the response identifier. If not, Edwin AI automatically generates a unique UUID to use as the response identifier.

Beyond the response ID, no assumptions are made about the structure of the returned payload. Any fields consumed by Edwin AI must be configured as organization-specific response mappings.

To support nested JSON objects, Edwin AI automatically flattens the response before applying mappings. the following table displays Edwin’s output for received payloads:

Requirements for Configuring HTTP Request Integration

Before setting up a new HTTP outbound payload, you must have the following:

• The EndpointURL of the HTTP endpoint.
  If another URL is defined in the Perform HTTP Request action step mappings, the mapping URL will override the integration URL.
• Headers stored as comma-separated header-name:header-value pairs in secrets and merged with headers defined in Perform HTTP Request action step mappings.
  The headers in mappings override headers of the same name from the integration configuration.
• Authentication details generated by the HTTP endpoint.

The following table details the required configuration fields based on authentication type:

These configuration parameters exist at the global and action levels.

Configuring HTTP Request Integration

1. In Edwin, navigate to Settings > Integrations.
2. Select Configure for HTTP Endpoint.
3. In the Name field, enter a name for the resource. 
4. In the Description field, enter a description for the resource. 
5. In the URL field, enter an endpoint URL.
6. In the Headers field, enter a header-name:header-value pair.
7. In the Authentication Type field, enter the authentication type for your external system.
   For more information on supported types, see Requirements for Configuring HTTP Request Integration.
8. Enter the credentials required by the authentication type.
   For more information, see Requirements for Configuring HTTP Request Integration.

9. (Optional) If using OAuth2 authentication, enter the scope of your credentials in the Scope field.
10. Select Save.

The HTTP Request integration displays in the active integrations list.

Configuring an HTTP Request Action

1. Create a new Edwin AI action, or edit an existing action.
   For more information, see Creating and Editing Action in Edwin AI.
2. In the Add Action dropdown menu, select “Perform HTTP Request.”
3. In the Mapped Fields section of the new action, add the mapped fields included in the outbound HTTP request.
   Use the following supported fields:

4. Select Submit.