Skip to main content
Connections define how RWS Integration authenticates with external APIs and services. Each connection type handles a different authentication pattern, from simple API keys to OAuth 2.0 flows. Choose your connection type based on how the target API expects authentication:
Connection TypeUse When
SimpleAPI requires headers only (API keys, basic auth)
OAuth 2.0API uses token-based authentication with client credentials
SessionAPI uses cookie-based session authentication
Google/GCPConnecting to Google Cloud Platform services

Simple

Headers and query params only

OAuth 2.0

Token-based authentication

Session

Cookie-based sessions

Google/GCP

Service account auth

​
Simple

Basic connection type for APIs that authenticate via HTTP headers. Use this when the API requires a static API key, basic authentication, or any header-based credential that doesn’t expire or refresh.

​
When to use

  • APIs with static API keys
  • Services using Authorization: Basic headers
  • Any API where credentials are passed directly in headers

​
Configuration

Simple connections require only the headers that the target API expects. No additional configuration is needed. Required fields:
FieldDescription
HeadersKey-value pairs to include in every request
Query ParamsKey-value pairs to include as URL query parameters

​
OAuth 2.0

Connection type for APIs that use OAuth 2.0 authentication. RWS Integration requests an access token from the OAuth server and includes it in subsequent API calls.

​
When to use

  • Enterprise APIs (Salesforce, HubSpot, Microsoft)
  • APIs requiring client credentials flow
  • Services where tokens expire and need refresh
  • Any API that issues Bearer tokens

​
Configuration

OAuth 2.0 connections require details about the token endpoint, how to extract the token from the response, and how the token should be sent in subsequent requests. Required fields:
FieldDescription
Token TypeHow the token is sent: Bearer (Authorization header) or Api Token (custom header)
Header Attribute NameThe header name used to send the token in subsequent requests. For Bearer type, this is automatically set to Authorization. For Api Token type, specify the custom header name (e.g., X-Auth-Token, Api-Key)
MethodHTTP method for the token request (typically POST)
Base URLBase URL of the OAuth server
PathEndpoint path for token requests (e.g., /oauth/token)
Token Path in ResponseJSON path to extract the token from the response body

​
Token Type and Header Attribute Name

The Token Type determines the format used when sending the token, while the Header Attribute Name specifies which header carries the token:
Token TypeHeader Attribute NameRequest Header Sent
BearerAuthorization (automatic)Authorization: Bearer {token}
Api TokenCustom (e.g., X-Auth-Token)X-Auth-Token: {token}
Api TokenCustom (e.g., Api-Key)Api-Key: {token}
Token Path examples:The token path tells RWS Integration where to find the access token in the OAuth server’s response.
Response StructureToken Path
{"access_token": "xyz"}access_token
{"data": {"token": "xyz"}}data.token
{"response": {"credentials": {"bearer": "xyz"}}}response.credentials.bearer

​
Session

Connection type for APIs that use session-based authentication via cookies. RWS Integration performs a login request, captures the Set-Cookie headers, and maintains the session for subsequent requests.

​
When to use

  • Legacy systems with session-based authentication
  • Internal APIs that require cookie authentication
  • Web services with login flows
  • Systems that don’t support modern token-based auth

​
Configuration

Session connections require the login endpoint details. RWS Integration automatically handles cookie capture and session management. Required fields:
FieldDescription
MethodHTTP method for the login request (typically POST)
Base URLBase URL of the authentication server
PathLogin endpoint path (e.g., /api/login)
RWS Integration captures all Set-Cookie headers from the login response and includes them automatically in all subsequent requests to the same base URL.

​
Google/GCP

Connection type for Google Cloud Platform services. Uses service account authentication to access GCP APIs like Google Sheets, BigQuery, Cloud Storage, and others.

​
When to use

  • Google Sheets integration
  • BigQuery data extraction or loading
  • Google Drive file operations
  • Cloud Storage (GCS) access
  • Any GCP API service

​
Configuration

GCP connections require a service account with appropriate permissions and the OAuth scopes for the services you need to access. Required fields:
FieldDescription
Google API ScopesOAuth scopes required for the GCP services (one per line)
Google Service Account (JSON)Full JSON key file content from your GCP service account

​
Common scopes

ServiceScope
Google Sheets (read/write)https://www.googleapis.com/auth/spreadsheets
Google Sheets (read only)https://www.googleapis.com/auth/spreadsheets.readonly
Google Drivehttps://www.googleapis.com/auth/drive
BigQueryhttps://www.googleapis.com/auth/bigquery
Cloud Storagehttps://www.googleapis.com/auth/devstorage.read_write

​
Permissions

The service account must have appropriate IAM permissions for the resources you want to access. For Google Sheets, share the spreadsheet directly with the service account email address (client_email in the JSON).

​
Next steps

Pagination

Handle different API pagination patterns

Business Rules

Transform data with JavaScript