Access API Request and Response Headers

Some APIs return important information in their request or response headers instead of the response body. This information can include session details, authentication values, routing information, or other data that is required for future API calls.

With Access API Request and Response Headers, integrations can capture and reuse these values when needed, making API communication more reliable and reducing unnecessary authentication calls.

Why Is This Useful?

Many integrations authenticate once and then use the returned information for all subsequent requests.

Without access to request and response headers, workflows may need to create a new session every time they run. This can lead to extra authentication requests, increased API traffic, and, in some cases, session-related issues.

By making request and response headers available, integrations can reuse previously returned values and continue using the same authenticated session until it expires.

How It Works

When an authentication request is made, the API may return important values in the response headers.

These request and response details can be stored with the Credential and reused by any workflow that uses the same connection.

Instead of authenticating for every workflow run, you can use the stored values for future requests.

asedd SData HubiSelect from one of the below responses generatedin the previous steps to use in the chosen field.Tip: Arrays start at 0. Use {{5.items.0.name}} forthe first item, {{5.items.1.name}} for the second.Write something to search…dynamic_payload{}last_success_sync_time“get_last_success_sync_time”last_sync_time“get_last_sync_time”credentialscr_hostname“https://dckap.integrationsuite-cloud”token“”token_requestLENGTH[{“method”:””,”request_headers”:{}}]method“”request_headers{}request_params{}request_payload{}response{}response_headers{}status_code200url“”SAP1ProductsPayloadVariables0Response ValidationiAdvanced OptionsHeadersiCookieB1SESSION={{special.credentials.token_request.0.response.SessionId}}; ROUTEID={{special.credentials.token_request.0.response_headers.Set-Cookie.1.split(;).0.split(=).1}}+ AddFilesiOverride TimeiURL ArgumentsiParametersiEnable API RetryiDisableShow output in console logsiEnableAPI Method and URLRequest InformationResponse InformationRequest Header InformationResponse Header InformationParams Information

When the authentication session expires, a new authentication request is automatically performed, and the updated request and response details are stored for future use.

Before

A typical integration flow looked like this:

  1. Authenticate with the API.
  2. Receive session information.
  3. Make API requests.
  4. Log out.
  5. Repeat the same process during the next workflow run.

Every workflow execution started with a new authentication request, even when valid session information already existed.

After

With Access API Request and Response Headers:

  1. Authenticate once.
  2. Store the required request and response information in the Credential.
  3. Reuse the stored values across workflows.
  4. Refresh authentication only when the session expires.

This allows multiple workflows to use the same authenticated connection without repeatedly creating new sessions.

Benefits

Fewer Authentication Requests

Reuse existing authentication details instead of signing in for every workflow execution.

Shared Authentication Across Workflows

Multiple workflows using the same Credential can access the same stored authentication information.

More Reliable API Communication

Reuse the header values returned by the API when future requests depend on them.

Easier Integration Design

Authentication can be managed centrally, reducing the need to add login and logout steps throughout workflows.