Appearance
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
| Guide | Description |
|---|---|
| How Connectors Work | Detailed request and response pipeline |
Setup
| Guide | Description |
|---|---|
| Build Your First Connector | Hands-on tutorial to create and call a connector |
| Configuration | Required and optional fields, naming, URL rules |
| Choose an Authentication Type | Decision guide for picking the right authentication type |
| Authentication | API Key, OAuth Client Credentials, None |
| Secrets and Variables | Store and manage credentials |
Request & Response
| Guide | Description |
|---|---|
| Headers & Query Parameters | Headers, query params, overridable fields |
| Dynamic URL Path Segments | Caller-supplied values as path segments in the URL, with URL-safe validation |
| Request Transformation | Reshape request bodies with Jinja2 |
| Response Transformation | Transform upstream API responses with Jinja2 |
| Template Variables | Variables, filters, and functions reference |
| HTTP Caching | Automatic response caching |
Using Connectors
| Guide | Description |
|---|---|
| Calling from Widget Code | Call connectors from widget code |
| Passing User Context | Securely inject user identity into connector requests |
| Filtering Sensitive Data | Strip hidden or private records from responses before they reach the browser |
| Testing & Debugging | Test connections, performance headers, troubleshooting |
Composite Connectors
| Guide | Description |
|---|---|
| Build a Composite Connector | Chain multiple API calls into a single execution |
| Composite Connector Reference | Step fields, template variables, and error types |
Managing as Code
| Guide | Description |
|---|---|
| Code Mode | Define connectors using JSON |
| Repository Registry | Define connectors in your GitHub repository |

