Configuration

Every connector requires a name, a destination URL, and an HTTP method. Everything else is optional and depends on what the external API expects.

The HTTP method you set here is fixed for this connector. Every SDK call must use the same method — the platform rejects requests that use a different method than the one configured.

Required fields

• Connection Name: Unique, descriptive name tied to the system or use case. Use names like "Salesforce Case Creation" or "Weather API Current Conditions" — avoid generic labels like "API" or "Test". The platform derives a permalink from this name.
• Endpoint URL: Full HTTPS endpoint. Supports template expressions in the path and query string — for example: https://api.example.com/users/{{ user.id }}/profile. Templating is not allowed in the protocol or host. Non-templated URLs must be HTTPS and cannot target localhost or private IP ranges.
• HTTP Method: GET, POST, PUT, PATCH, DELETE, HEAD, or OPTIONS.

Optional fields

• Headers: Content type, API versions, or custom headers. See Headers & Query Parameters.
• Query Parameters: Search filters, pagination, or API keys. See Headers & Query Parameters.
• Authentication Type: API Key, OAuth Client Credentials, JWT, or OAuth JWT Bearer. Always use Secrets for credential values. See Authentication.
• Request Transformation: Template to reshape the request body for POST/PUT/PATCH requests. See Request Transformation.
• Response Body: Template to transform the upstream response before returning it to the widget. See Response Transformation.
• Response Content-Type: Override the Content-Type header on the response returned to the widget.

Permalink

The permalink is a URL-safe identifier derived from the Connection Name (lowercase, spaces replaced by hyphens). You use it when calling the connector from widget code:

sdk.connectors.execute({ permalink: "weather-api", method: "GET" });

URL template limitations

URL templates render without access to secrets — use Headers & Query Parameters or Authentication fields for credentials instead. See Secrets for details on this limitation.

Next Steps

• Authentication — Configure API keys or OAuth
• Headers & Query Parameters — Add static or overridable values
• Secrets — Store credentials securely