@@ -10240,7 +10240,7 @@ paths:
1024010240 "$ref": "#/components/schemas/intercom_version"
1024110241 - name: id
1024210242 in: path
10243- description: The unique identifier of the data connector
10243+ description: The unique identifier of the data connector.
1024410244 example: '12345'
1024510245 required: true
1024610246 schema:
@@ -10249,9 +10249,9 @@ paths:
1024910249 - Data Connectors
1025010250 operationId: RetrieveDataConnector
1025110251 description: |
10252- You can retrieve a single data connector by its ID.
10252+ You can retrieve the full detail of a single data connector by its ID.
1025310253
10254- The response includes full detail about the connector including its configuration, data inputs, response fields, and object mappings.
10254+ The response includes configuration, data inputs, response fields, and object mappings.
1025510255 responses:
1025610256 '200':
1025710257 description: Data connector found
@@ -10267,11 +10267,37 @@ paths:
1026710267 state: live
1026810268 http_method: post
1026910269 direct_fin_usage: false
10270+ audiences:
10271+ - users
10272+ - leads
10273+ execution_type: server_side
10274+ configuration_response_type: test_response_type
10275+ data_transformation_type:
10276+ client_function_name:
10277+ client_function_timeout_ms:
10278+ data_inputs:
10279+ - name: conversation_id
10280+ type: string
10281+ description: The Intercom conversation ID
10282+ required: true
10283+ source: fin
10284+ response_fields:
10285+ - path: status
10286+ type: string
10287+ example_value: ok
10288+ redacted: false
10289+ object_mappings: []
10290+ token_ids: []
10291+ customer_authentication: false
10292+ bypass_authentication: false
10293+ validate_missing_attributes:
10294+ created_by_admin_id: '456'
10295+ updated_by_admin_id: '456'
1027010296 created_at: '2025-11-15T09:30:00Z'
1027110297 updated_at: '2026-01-20T14:22:15Z'
1027210298 execution_results_url: "/data_connectors/12345/execution_results"
1027310299 schema:
10274- "$ref": "#/components/schemas/data_connector "
10300+ "$ref": "#/components/schemas/data_connector_detail "
1027510301 '404':
1027610302 description: Data connector not found
1027710303 content:
@@ -21724,6 +21750,248 @@ components:
2172421750 type: string
2172521751 description: The URL path to fetch execution results for this connector.
2172621752 example: "/data_connectors/12345/execution_results"
21753+ data_connector_detail:
21754+ title: Data Connector (Detail)
21755+ type: object
21756+ x-tags:
21757+ - Data Connectors
21758+ description: |
21759+ Full detail view of a data connector, returned by `GET /data_connectors/{id}`.
21760+ Includes configuration, data inputs, response fields, and object mappings.
21761+ properties:
21762+ type:
21763+ type: string
21764+ description: The type of object - `data_connector`.
21765+ enum:
21766+ - data_connector
21767+ example: data_connector
21768+ id:
21769+ type: string
21770+ description: The unique identifier for the data connector.
21771+ example: '12345'
21772+ name:
21773+ type: string
21774+ description: The name of the data connector.
21775+ example: Slack Notification Service
21776+ description:
21777+ type: string
21778+ nullable: true
21779+ description: A description of what this data connector does.
21780+ example: Posts conversation updates to Slack channel
21781+ state:
21782+ type: string
21783+ description: The current state of the data connector.
21784+ enum:
21785+ - draft
21786+ - live
21787+ example: live
21788+ http_method:
21789+ type: string
21790+ description: The HTTP method used by the data connector.
21791+ enum:
21792+ - get
21793+ - post
21794+ - put
21795+ - delete
21796+ - patch
21797+ example: post
21798+ direct_fin_usage:
21799+ type: boolean
21800+ description: Whether this connector is used directly by Fin.
21801+ example: false
21802+ audiences:
21803+ type: array
21804+ description: The audience types this connector targets.
21805+ items:
21806+ type: string
21807+ enum:
21808+ - users
21809+ - leads
21810+ - visitors
21811+ example:
21812+ - users
21813+ - leads
21814+ execution_type:
21815+ type: string
21816+ nullable: true
21817+ description: How the connector executes.
21818+ enum:
21819+ - server_side
21820+ - client_side
21821+ example: server_side
21822+ configuration_response_type:
21823+ type: string
21824+ nullable: true
21825+ description: The expected response format from the connector.
21826+ enum:
21827+ - test_response_type
21828+ - mock_response_type
21829+ example: test_response_type
21830+ data_transformation_type:
21831+ type: string
21832+ nullable: true
21833+ description: The type of data transformation applied to the response.
21834+ enum:
21835+ - full_access
21836+ - redacted_access
21837+ - code_block_transformation
21838+ client_function_name:
21839+ type: string
21840+ nullable: true
21841+ description: The name of the client-side function, if applicable.
21842+ client_function_timeout_ms:
21843+ type: integer
21844+ nullable: true
21845+ description: Timeout in milliseconds for the client function, if applicable.
21846+ data_inputs:
21847+ type: array
21848+ description: The input parameters accepted by this data connector.
21849+ items:
21850+ type: object
21851+ properties:
21852+ name:
21853+ type: string
21854+ description: The name of the input parameter.
21855+ example: conversation_id
21856+ type:
21857+ type: string
21858+ description: The data type of the input.
21859+ enum:
21860+ - string
21861+ - integer
21862+ - decimal
21863+ - boolean
21864+ example: string
21865+ description:
21866+ type: string
21867+ nullable: true
21868+ description: A description of the input parameter.
21869+ required:
21870+ type: boolean
21871+ description: Whether this input is required.
21872+ example: true
21873+ default_value:
21874+ nullable: true
21875+ description: The default value for this input, if any.
21876+ source:
21877+ type: string
21878+ nullable: true
21879+ description: The source context for this input.
21880+ enum:
21881+ - fin
21882+ - custom
21883+ - attribute
21884+ example: fin
21885+ response_fields:
21886+ type: array
21887+ description: The fields returned in the connector response.
21888+ items:
21889+ type: object
21890+ properties:
21891+ path:
21892+ type: string
21893+ description: The JSON path of the response field.
21894+ example: status
21895+ type:
21896+ type: string
21897+ description: The data type of the response field.
21898+ enum:
21899+ - unknown
21900+ - string
21901+ - integer
21902+ - decimal
21903+ - datetime
21904+ - boolean
21905+ example: string
21906+ example_value:
21907+ nullable: true
21908+ description: An example value for this field.
21909+ example: ok
21910+ redacted:
21911+ type: boolean
21912+ description: Whether this field is redacted in logs.
21913+ example: false
21914+ object_mappings:
21915+ type: array
21916+ description: Mappings from connector response objects to Intercom objects.
21917+ items:
21918+ type: object
21919+ properties:
21920+ response_object_path:
21921+ type: string
21922+ intercom_object_type:
21923+ type: string
21924+ enum:
21925+ - conversation
21926+ - user
21927+ attribute_mappings:
21928+ type: array
21929+ items:
21930+ type: object
21931+ properties:
21932+ response_attribute_path:
21933+ type: string
21934+ intercom_attribute_identifier:
21935+ type: string
21936+ mapping_type:
21937+ type: string
21938+ enum:
21939+ - primitive_mapping
21940+ - context_mapping
21941+ reference_mappings:
21942+ type: array
21943+ items:
21944+ type: object
21945+ properties:
21946+ intercom_object_type:
21947+ type: string
21948+ enum:
21949+ - conversation
21950+ - user
21951+ intercom_attribute_identifier:
21952+ type: string
21953+ token_ids:
21954+ type: array
21955+ description: IDs of authentication tokens associated with this connector.
21956+ items:
21957+ type: string
21958+ example: []
21959+ customer_authentication:
21960+ type: boolean
21961+ description: Whether OTP authentication is enabled for this connector.
21962+ example: false
21963+ bypass_authentication:
21964+ type: boolean
21965+ description: Whether authentication is bypassed for this connector.
21966+ example: false
21967+ validate_missing_attributes:
21968+ type: boolean
21969+ nullable: true
21970+ description: Whether to validate missing attributes before execution.
21971+ created_by_admin_id:
21972+ type: string
21973+ nullable: true
21974+ description: The ID of the admin who created this connector.
21975+ example: '456'
21976+ updated_by_admin_id:
21977+ type: string
21978+ nullable: true
21979+ description: The ID of the admin who last updated this connector.
21980+ example: '456'
21981+ created_at:
21982+ type: string
21983+ format: date-time
21984+ description: The time the data connector was created.
21985+ example: '2025-11-15T09:30:00Z'
21986+ updated_at:
21987+ type: string
21988+ format: date-time
21989+ description: The time the data connector was last updated.
21990+ example: '2026-01-20T14:22:15Z'
21991+ execution_results_url:
21992+ type: string
21993+ description: The URL path to fetch execution results for this connector.
21994+ example: "/data_connectors/12345/execution_results"
2172721995 data_connector_execution_result:
2172821996 title: Data Connector Execution Result
2172921997 type: object
0 commit comments