With the HTTP Action, call internal and external web services from an Omniscript
without coding or making Salesforce API calls. You can call an HTTP API that allows Apex, Named
Credentials, SOAP/XML, or Web, and use the Omniscript's JSON as input.
To make sure that the HTTP Action functions correctly without errors related to Content
Security Policy (CSP) restrictions, you must add a trusted URL in the Setup, and specify
CSP directives and Permissions-Policy directives. When adding this URL, it's important to
select all checkboxes under CSP Directives to fully configure the directives. See Add or Edit a Trusted URL.
Use the HTTP Action to:
-
Send GET, POST, PUT, or DELETE requests to standard REST Endpoints.
-
Call Apex REST.
-
Access Salesforce Named Credential (OAuth) identity services.
Configure the HTTP settings to call web services.
|
Property
|
Description
|
|
HTTP Path
|
The request URL of the API. For example, /NS/v1/application. NS = namespace of the
Apex REST API. The path can contain merge fields. For
example, to pass a UserId node from the data JSON, add the node name with
percentage signs on either side, i.e., %UserId%. |
|
HTTP Method
|
The method name, which has two parameters. For example,
doPost(String fullJSON, String filesMap).
GET,
POST, PUT, PATCH, or DELETE.
|
|
Endpoint Type
|
Specifies the endpoint type:
-
Apex — Invokes Apex REST. You must add the Salesforce org's domain to
a Remote Site's Remote Site URL field.
-
Named Credential — Access Salesforce Named Credential (OAuth) identity
services.
-
SOAP/XML — Send requests to standard REST endpoints using XML format
for the request and response bodies.
-
Web — Send requests to standard REST endpoints (unauthenticated or
credentials in HTTP headers).
|
|
Named Credential
|
Salesforce named credential. For Named Credential and optionally SOAP/XML
endpoint types.
|
|
HTTP Headers
|
HTTP headers specified as key-value pairs. Supports merge field syntax.
|
|
Parameters
|
URL parameters specified as Key/Value pairs. Supports merge field
syntax.
|
|
Encode URI
|
Uses HTML escape codes in the URI.
|
|
Cache response
|
Caches the response.
|
|
Require credentials
|
Requires security credentials such as a username and password.
|
|
Extra Payload
|
Sends additional Key/Value pairs. Supports merge field syntax.
|
|
Send body
|
Sends the Extra Payload as the request body for a POST action.
|
|
Send only extra payload
|
Enables the action to send Extra Payload's key-value pairs without including
the Omniscript's data JSON.
|
