HTTP Action for Integration Procedures

The HTTP Action executes a REST call and returns its results to the Integration Procedure. The HTTP Action in Integration Procedures supports only getBody() for returning the response. Use Apex directly via a Remote Action to handle binary responses.

Property

Description

  • Request URL
  • HTTP Path (If you're using the designer on a managed package)

URL to call. For Apex REST actions, you can use merge fields to set this property. You can pass percentage signs in the URL by replacing the percentage sign in the Path with the variable $Vlocity.Percent.

HTTP Method

GET, POST, PUT, PATCH, or DELETE

Named Credential

Salesforce named credential required for endpoint. We recommend that you use Named Credentials for securely managing authentication data.

Starting in Summer '24, Omnistudio supports Salesforce Private Connect. You can use named credentials to make outbound HTTP calls from an Omnistudio org to an external service that runs on AWS. For information on how to set up a named credential with Private Connect, see Establish an Outbound Connection with AWS.

REST Options: Header

HTML header settings specified as key-value pairs. For data security purposes, avoid hardcoding sensitive data in the HTML header.

To change the character set for a REST call, set the key to content-type and the value to something like application/json; charset=utf-8. Note that content-type is all lowercase. The default content-type is text/plain; charset=ISO-8859-1 if none is set.

REST Options: Params

URL parameters specified as key-value pairs

  • Request Body
  • Send Body (If you're using the designer on a managed package)

Enable a POST action to send Body contents

Timeout

How long in milliseconds to wait for a response

Client Certificate Name

For two-factor authentication, the name of the client certificate to be used.

Debug Logging:

  • Pre-Action Log and Post-Action Log
  • Pre-action Logging and Post-action Logging (If you're using the designer on a managed package)

Specifies information to be added to the Preview tab's Debug Output pane before or after the action is attempted. You can log values from PropertySetMap and these merge fields:

  • Pre-Action: %endpoint% and %body%

  • Post-Action: %stepName + 'Info'% and %stepName + 'Info:Content-Type'%

For example:

%stepName + 'Status'%

Retry Count

Number of times to retry action when it fails

Escape XML Response

Remove XML escapes from an XML response