HTTP Action Properties (Managed Package)

For the managed package runtime, this page contains information on HTTP Action Properties.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Property

Description

HTTP Path

URL to call. For Apex REST actions, you can use merge fields to set this property.

Beginning with Vlocity Spring '19, 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.

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

Caches the response.

With 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.