Create connector
POST/integrations/connectors
Creates a new integration connector account. Provide the connector type, authentication method, and any initial configuration or credentials. Credentials are stored encrypted. The key is derived from the name if not supplied (slugified, underscore-separated).
Request
Request body
Content type application/json (required).
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name for this connector (e.g. "Salesforce CRM"). Max length: 120 |
key | string, nullable | No | Unique machine-readable key (slug). Auto-derived from name if omitted. Stored as lowercase underscore slug. Max length: 80 |
type | string | Yes | Category of the external system being connected. One of: |
auth_type | string | Yes | Authentication mechanism used by this connector. One of: |
status | string | No | Operational status of the connector. One of: |
config_json | string, nullable | No | JSON object of non-sensitive configuration such as base_url, scopes, or feature flags. |
credentials_json | string, nullable | No | JSON object of sensitive credentials (API keys, tokens). Stored encrypted at rest. Treat this field as write-only. |
Example
{
"name": "Salesforce CRM",
"type": "crm",
"auth_type": "oauth2",
"status": "active",
"config_json": "{\"base_url\":\"https://example.salesforce.com\",\"scopes\":[\"read\",\"write\"]}",
"credentials_json": "{\"client_id\":\"SF_CLIENT_ID\",\"client_secret\":\"SF_CLIENT_SECRET\"}"
}Responses
302 Redirect to connectors list after creation
422 Validation error — name, type, and auth_type are required
Content type application/json, any.
Example
{
"errors": {
"type": [
"The selected type is invalid."
]
}
}Example request
curl -X POST "https://{tenant}.faciotech.net/api/v1/integrations/connectors" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name": "Salesforce CRM", "type": "crm", "auth_type": "oauth2", "status": "active", "config_json": "{\"base_url\":\"https://example.salesforce.com\",\"scopes\":[\"read\",\"write\"]}", "credentials_json": "{\"client_id\":\"SF_CLIENT_ID\",\"client_secret\":\"SF_CLIENT_SECRET\"}"}'