Skip to content

Overview

Connectors let your widgets talk to external services — like Salesforce, weather APIs, or any HTTP endpoint — without exposing credentials in the browser. You configure a connector once, and any widget can call it securely. They are commonly used inside Custom Widgets to fetch or send data from widget code via the SDK.

New to connectors? Start with Build Your First Connector.

Why use connectors

Use them when you want to:

  • Pull data from another system
  • Send data to a service you rely on
  • Reuse the same Connector across teams
  • Keep auth and request formats consistent

They also protect sensitive data in client-side apps. Without connectors, browser code must call external APIs directly, which exposes API keys and tokens. With connectors, requests run on the backend and secrets stay on the server.

Typical examples are CRM lookups, payment processing, monitoring services, and data enrichment.

Guides

GuideDescription
How Connectors WorkDetailed request and response pipeline
ConfigurationRequired and optional fields, naming, URL rules
AuthenticationAPI Key, OAuth Client Credentials, None
Headers & Query ParametersHeaders, query params, overridable fields
Request TransformationReshape request bodies with Jinja2
Response TransformationTransform upstream API responses with Jinja2
SecretsStore and manage credentials
Calling from Widget CodeCall connectors from widget code
Passing User ContextSecurely inject user identity into connector requests
Filtering Sensitive DataStrip hidden or private records from responses before they reach the browser
Template VariablesVariables, filters, and functions reference
SDKFull SDK documentation — install, API, types, examples
Testing & DebuggingTest connections, performance headers, troubleshooting
HTTP CachingAutomatic response caching
Code ModeDefine connectors using JSON
Repository RegistryDefine connectors in your GitHub repository

Gainsight CC Developer Portal