Skip to main content
GET
List Callouts

Authorizations

Authorization
string
header
required

Query Parameters

limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

page
integer
default:1

Page number. Defaults to 1 when omitted

Response

OK

Name
string

Administrator-facing unique name

Example:

"Create Salesforce case"

TargetURL
string<uri>
Example:

"https://gateway.internal.example.com/support/cases"

Method
enum<string>
Available options:
POST,
PUT,
PATCH
AuthenticationType
enum<string>
default:static_header

Authentication Portal uses for the destination request

Available options:
static_header,
oauth2_client_credentials,
none
AuthHeaderName
string

Required when AuthenticationType is static_header. Portal-managed, hop-by-hop, and proxy header names are rejected, including Accept, Connection, Content-Length, Content-Type, Host, Keep-Alive, TE, Trailer, Transfer-Encoding, Upgrade, X-Callout-Request-ID, and any name beginning with Proxy-.

Example:

"X-Portal-Callout-Key"

OAuthTokenURL
string<uri>

Required when AuthenticationType is oauth2_client_credentials

Example:

"https://identity.example.com/oauth/token"

OAuthClientID
string

Required when AuthenticationType is oauth2_client_credentials

Maximum string length: 1024
Example:

"portal-callouts"

OAuthScopes
string

Optional space-separated OAuth scope tokens

Maximum string length: 4096
Example:

"cases.write profile"

IncludeActorIdentity
boolean
default:false

Include the authenticated Portal user's CID and email address in the outbound request

TLSInsecureSkipVerify
boolean
default:false

Allow unverified TLS certificates for the target and OAuth token endpoint

Timeout
integer
default:5

Outbound request timeout in seconds, separate from the Portal request body read timeout

Required range: 1 <= x <= 10
Enabled
boolean
default:false
ID
integer
Example:

1

CID
string

Opaque identifier used by the browser Callout endpoint

CreatedAt
string
UpdatedAt
string