Skip to content

Data Connector

A data connector allows you to make HTTP requests to external APIs from Intercom workflows and AI agents.

typestring

The type of object - data_connector.

Value:"data_connector"
Example:"data_connector"
idstring

The unique identifier for the data connector.

Example:"12345"
namestring

The name of the data connector.

Example:"Order Status Service"
descriptionstring or null

A description of what this data connector does.

Example:"Fetches order status from external fulfillment API"
statestring

The current state of the data connector.

Enum:"draft""live"
Example:"live"
http_methodstring

The HTTP method used by the data connector.

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

Whether this data connector is assigned to Fin for direct usage.

Example:false
created_by_admin_idstring

The ID of the admin who created this data connector.

Example:"12345"
updated_by_admin_idstring

The ID of the admin who last updated this data connector.

Example:"12345"
created_atstring, (date-time)

The time the data connector was created.

Example:"2025-11-15T09:30:00Z"
updated_atstring, (date-time)

The time the data connector was last updated.

Example:"2026-01-20T14:22:15Z"
execution_results_urlstring

The URL path to fetch execution results for this connector.

Example:"/data_connectors/12345/execution_results"
{ "type": "data_connector", "id": "12345", "name": "Order Status Service", "description": "Fetches order status from external fulfillment API", "state": "live", "http_method": "post", "direct_fin_usage": false, "created_by_admin_id": "12345", "updated_by_admin_id": "12345", "created_at": "2025-11-15T09:30:00Z", "updated_at": "2026-01-20T14:22:15Z", "execution_results_url": "/data_connectors/12345/execution_results" }