Skip to main content
POST
Proxy Request (Legacy)
This endpoint is deprecated

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json

The request body

url
string | null

The base url of the request

Example:

"https://api.sample-integration.com/v1"

method
enum<string> | null
default:get

The method of the request

Available options:
get,
post,
put,
delete,
patch,
null
path
string | null

The path of the request including any query parameters

Example:

"/employees/directory"

headers
object | null

The headers to send in the request

Example:
body
object | null

The body of the request

Response

The proxy request was successful.

status
number
required

The HTTP status code returned by the provider

Example:

200

headers
object | null

The headers returned by the provider

Example:
data

The response data from the provider. Can be an object, array, or primitive value.

Example:
provider_errors
object[] | null

Provider-specific errors if any occurred

Example: