Skip to content

Connectors

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 Extensions to fetch or send data from widget code via the SDK.

New to connectors? Start with Build Your First Connector.

Why use connectors

Connectors keep API keys and tokens out of the browser — requests run on the backend, so secrets stay on the server. They also let you configure a call once, such as a CRM lookup or payment integration, and reuse it across every widget in your community.

Guides

Connectors

GuideDescription
How Connectors WorkDetailed request and response pipeline

Setup

GuideDescription
Build Your First ConnectorHands-on tutorial to create and call a connector
ConfigurationRequired and optional fields, naming, URL rules
Choose an Authentication TypeDecision guide for picking the right authentication type
AuthenticationAPI Key, OAuth Client Credentials, None
Secrets and VariablesStore and manage credentials

Request & Response

GuideDescription
Headers & Query ParametersHeaders, query params, overridable fields
Dynamic URL Path SegmentsCaller-supplied values as path segments in the URL, with URL-safe validation
Request TransformationReshape request bodies with Jinja2
Response TransformationTransform upstream API responses with Jinja2
Template VariablesVariables, filters, and functions reference
HTTP CachingAutomatic response caching

Using Connectors

GuideDescription
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
Testing & DebuggingTest connections, performance headers, troubleshooting

Composite Connectors

GuideDescription
Build a Composite ConnectorChain multiple API calls into a single execution
Composite Connector ReferenceStep fields, template variables, and error types

Managing as Code

GuideDescription
Code ModeDefine connectors using JSON
Repository RegistryDefine connectors in your GitHub repository

Gainsight CC Developer Portal