request

Step function: request

Input

v1

Field	Description	Type	Required
args	Request parameters to send as query, body, or header values.	object[]	No
authorization	Overrides the connector’s default authentication for this request.	union	No
baseUrl	Overrides the connector’s base URL for this request.	string	No
cacheTTL	Minutes to serve this request from the shared per-account response cache. 0 or omitted disables caching.	integer	No
certificates	Client TLS certificates and keys for mutual TLS connections.	object	No
customErrors	Remaps matching provider error responses to different statuses or messages.	object[]	No
encodeQueryParams	Whether to URL-encode query parameter values before sending.	boolean	No
method	HTTP method to use: get, post, put, patch, or delete. Allowed: get, post, put, delete, patch	enum	Yes
response	Controls how the raw response is parsed into step output data.	object	No
saml	Generates a signed SAML assertion and merges it into the request body for token exchange.	object	No
url	Endpoint path appended to the base URL.	string	Yes

args

Request parameters to send as query, body, or header values.

Field	Description	Type	Required
arrayFormat	How array values are serialized in the query string: repeat, brackets, comma, or stringify. Allowed: repeat, brackets, comma, stringify	enum	No
condition	A JEXL expression that includes the parameter only when it evaluates true.	string	No
in	Where to send the parameter: query, body, or headers. Allowed: query, body, headers	enum	Yes
inline	Sends the string value as the raw request body. Valid only as the sole in: body argument.	boolean	No
name	Name of the request parameter.	string	Yes
spread	Merges the value’s object entries into the target location instead of setting a single named field.	boolean	No
value	Value of the parameter. Supports expressions.	any	Yes

authorization

Overrides the connector’s default authentication for this request.

none

Field	Description	Type	Required
redirectUri	OAuth callback URL carried as connect-time metadata. Not used when authorizing requests.	string	No
signing	Optional request signing applied to outgoing requests. Selects AWS SigV4 or HMAC signing.	union	No
type	Sends requests without an authorization header.	string	Yes

authorization.none.signing

Optional request signing applied to outgoing requests. Selects AWS SigV4 or HMAC signing.

aws4

Field	Description	Type	Required
region	AWS region used in the signing credential scope. Falls back to the credential region or us-east-1 when omitted.	string	No
service	AWS service name used in the signing credential scope. For example s3 or execute-api.	string	Yes
strategy	Signs requests with AWS Signature Version 4.	string	Yes

hmac

Field	Description	Type	Required
algorithm	Hash algorithm for the HMAC signature. Defaults to sha256. Allowed: sha1, sha256, sha512	enum	No
dateFormat	Timestamp format used in the signed string. Either iso8601 (default) or rfc2822. Allowed: iso8601, rfc2822	enum	No
headerName	Header the signature is written into. Defaults to X-Signature.	string	No
includeBodyHash	Hash the request body into the signed string, defaulting to true. When false, form-urlencoded body params are folded into the canonical string instead.	boolean	No
includeHost	Include the request hostname in the signed canonical string. Defaults to false.	boolean	No
outputFormat	Where the signature is emitted. header writes a signature header and basic writes an HTTP Basic Authorization header. Allowed: header, basic	enum	No
prefix	Prefix prepended to the signature value in the header. Defaults to hmac-<algorithm>.	string	No
strategy	Signs requests with an HMAC signature over a canonical request string.	string	Yes
username	Username paired with the signature when outputFormat is basic.	string	No

basic

Field	Description	Type	Required
encoding	Encoding applied to the username:password pair. Defaults to base64.	string	No
password	Password for HTTP Basic authentication.	string	No
redirectUri	OAuth callback URL carried as connect-time metadata. Not used when authorizing requests.	string	No
type	Configures HTTP Basic authentication.	string	Yes
username	Username for HTTP Basic authentication.	string	No

bearer

Field	Description	Type	Required
includeBearer	Prefix the token with Bearer in the Authorization header. Defaults to true. Default: true	boolean	Yes
redirectUri	OAuth callback URL carried as connect-time metadata. Not used when authorizing requests.	string	No
token	Token sent on each request. Supports expressions.	string	Yes
type	Configures bearer token authentication.	string	Yes

oauth2

Field	Description	Type	Required
additionalTokenFields	Extra credential fields to read from the token endpoint response. Each key is a credential name and each value an expression.	object	No
authorizationParams	Extra query parameters appended to the authorization URL. Values support expressions.	object	No
authorizationUrl	Provider authorization endpoint where the user grants access.	string	No
callbackParams	Maps OAuth callback query parameter names to the credential keys their values are stored under. Cannot target reserved credential keys.	object	No
customHeaders	Additional HTTP headers sent with token endpoint requests.	object	No
includeBearer	Prefix the token with Bearer in the Authorization header. Defaults to true. Default: true	boolean	Yes
issuer	OpenID Connect issuer identifier for the provider.	string	No
pkce	Enable PKCE for the authorization code flow.	boolean	No
redirectUri	Overrides the OAuth callback URL. The computed callback URL can be seen on the connector profile.	string	No
scopeDelimiter	Delimiter used to separate scopes when requesting authorization.	string	No
scopes	OAuth scopes requested during authorization.	string	No
token	Expression that resolves the access token sent on each request.	string	Yes
tokenExpiresIn	Access token lifetime in seconds.	number	No
tokenParams	Extra parameters sent to the token endpoint. Values support expressions.	object	No
tokenRefreshExpiresIn	Refresh token lifetime in seconds.	number	No
tokenResponse	Adjusts how a non-standard token endpoint response is parsed.	object	No
tokenUrl	Provider token endpoint used to exchange the authorization code and to refresh tokens.	string	No
type	Configures OAuth 2.0 authentication.	string	Yes

authorization.oauth2.tokenResponse

Adjusts how a non-standard token endpoint response is parsed.

Field	Description	Type	Required
acceptTokenTypes	Allowlist of token_type values to accept from the token endpoint beyond Bearer and DPoP. Matched case-insensitively.	string[]	No
accessToken	Expression locating the access token in the token endpoint response. Takes precedence over the standard access_token field when it resolves to a non-empty string.	string	No
refreshToken	Expression locating the refresh token in the token endpoint response. Takes precedence over the standard refresh_token field when it resolves to a non-empty string.	string	No

certificates

Client TLS certificates and keys for mutual TLS connections.

Field	Description	Type	Required
certs	PEM-encoded client certificates for mutual TLS. Each entry is a raw or base64-encoded PEM certificate.	string[]	No
keys	PEM-encoded client private keys for mutual TLS. Each entry is a raw or base64-encoded PEM private key.	string[]	No

customErrors

Remaps provider error responses to different statuses or messages. Useful for GraphQL APIs that return errors with a 200 status, normalizing provider-specific error formats, and giving AI agents clearer error messages.

Field	Description	Type	Required
condition	A JEXL expression that applies the remap only when it evaluates true.	string	No
message	Error message to return in place of the provider’s.	string	No
receivedStatus	Provider HTTP status code to match.	number	Yes
targetStatus	HTTP status code to return in place of the matched one.	number	Yes

response

Controls how the raw response is parsed into step output data.

Field	Description	Type	Required
collection	Whether to treat the response payload as a collection of records to index.	boolean	No
dataKey	Path to the field in the response holding the records to extract.	string	No
indexField	Field used to key results when returning an indexed map.	string	No

saml

Generates a signed SAML assertion and merges it into the request body for token exchange.

Field	Description	Type	Required
audience	Intended audience for the assertion.	string	No
cert	Signing certificate for the SAML assertion.	any	No
clientId	Client identifier included as the api_key attribute in the assertion.	string	Yes
issuer	Issuer identifier declared in the assertion.	string	No
key	Base64-encoded private key used to sign the SAML assertion.	string	Yes
lifetime	Assertion validity window in seconds.	number	No
nameId	Subject NameID identifying the authenticating principal.	string	No
nameIdentifierFormat	Format URI for the subject NameID.	string	No
objectKey	Request body key under which the generated base64 SAML assertion is placed.	string	Yes
tokenEndpoint	Recipient token endpoint the assertion is addressed to.	string	No

Output

v1

Field	Description	Type	Required
data	The parsed response payload extracted from the provider response.	any	No
message	Status or error message from the response.	string	No
raw	The raw provider response before parsing.	any	No
statusCode	HTTP status code of the provider response.	number	Yes