Skip to content
Home/
REST API Reference
/
/
Create Data Connector Req...

Create Data Connector Request

You can create a data connector by providing the required parameters.

namestringrequired

The name of the data connector.

Example:"Get Order Status"
descriptionstring

A description of what this data connector does.

Example:"Looks up order status from an external service"
http_methodstring

The HTTP method used when calling the external API.

Enum:"get""post""put""delete""patch"
Example:"get"
urlstring

The URL of the external API endpoint. Supports template variables like {{order_id}}.

Example:"https://api.example.com/orders/{{order_id}}/status"
bodystring

The request body template. Supports template variables.

direct_fin_usageboolean

Whether the connector is used directly by Fin (true) or only in workflows (false). Defaults to false.

Example:false
audiencesArray of strings

The user types this connector is available for.

Items Enum:"leads""users""visitors"
Example:
[
  "leads",
  "visitors"
]
headersArray of objects

HTTP headers to include in the request.

data_inputsArray of objects

Input parameters accepted by the connector.

customer_authenticationboolean

Whether the connector requires customer authentication before executing. Defaults to false.

Example:false
bypass_authenticationboolean

Whether authentication is bypassed entirely (public endpoint). Defaults to false.

Example:false
validate_missing_attributesboolean

Whether to validate that all required data inputs have values before executing.

Example:false
mock_responseobject

A sample JSON response from the external API. Auto-generates response_fields and sets configuration_response_type to mock_response_type.

Example:
{
  "order": {
    "id": 12345,
    "status": "shipped"
  }
}
token_idsArray of strings

IDs of authentication tokens to attach to this data connector.

Example:
[
  "1234",
  "5678"
]
data_transformation_typestring or null

The type of data transformation to apply to the response. Setting this to code_block_transformation requires transform_code_block to also be set.

Enum:"full_access""redacted_access""code_block_transformation"
Example:"code_block_transformation"
transform_code_blockobject or null

The code block to use when data_transformation_type is code_block_transformation. New connectors are created in draft state, so the code block test described on Update a data connector does not run until the connector is published. null is the same as omitting this field.

Example:
{
  "code": "def transform(response):\n    return {\"status\": response[\"order_status\"]}\n\nreturn transform(inputs['data'])\n",
  "language": "python"
}
{
  "name": "Get Order Status",
  "description": "Looks up order status from an external service",
  "http_method": "get",
  "url": "https://api.example.com/orders/{{order_id}}/status",
  "body": "string",
  "direct_fin_usage": false,
  "audiences": [
    "leads",
    "visitors"
  ],
  "headers": [
    { … }
  ],
  "data_inputs": [
    { … }
  ],
  "customer_authentication": false,
  "bypass_authentication": false,
  "validate_missing_attributes": false,
  "mock_response": {
    "order": { … }
  },
  "token_ids": [
    "1234",
    "5678"
  ],
  "data_transformation_type": "code_block_transformation",
  "transform_code_block": {
    "code": "def transform(response):\n    return {\"status\": response[\"order_status\"]}\n\nreturn transform(inputs['data'])\n",
    "language": "python"
  }
}