Automations are now Agentic Workflows! Same setup, smarter execution. Multi-step processes handled automatically, end to end.
See our Release Notes
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Smart Connectors

post

Start the smart connector flow. For bulk action connectors, pass entity_records_set_key from a bulk action summary to run on selected records.

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Path parameters
connector_identifierstringRequired
Query parameters
orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:
Body
source_file_idstring · uuid · nullableWrite-onlyOptional

UUID of the uploaded input file (S3 object) to run the connector against. Upload a CSV or XLSX file via the presigned upload flow with source=smart_connector_import and pass the returned s3object_id here. If omitted, the connector's reference input file is used.

reprocess_execution_idstring · uuid · nullableWrite-onlyOptional

UUID of a previous execution to reprocess. When provided, the connector reruns using that execution's input file and metadata, and source_file_id is ignored.

is_dry_runbooleanOptional

When true, validates the input file without committing changes (dry run). When false, performs a live run that writes records.

Default: false
disable_diff_checkbooleanOptional

When true, skips the connector's diff-check validation.

Default: false
trigger_typestring · enumOptional
  • fileupload - File Upload
  • webhook - Webhook
  • activity - Activity
  • schedule - Schedule
  • bulkaction - Bulk Action
Possible values:
entity_records_set_keystring · min: 1 · nullableOptional

Cache key from bulk action summary containing selected record IDs. Only for bulk action connectors.

Responses
200Success
application/json
is_dry_runbooleanOptional

When true, validates the input file without committing changes (dry run). When false, performs a live run that writes records.

Default: false
disable_diff_checkbooleanOptional

When true, skips the connector's diff-check validation.

Default: false
trigger_typestring · enumOptional
  • fileupload - File Upload
  • webhook - Webhook
  • activity - Activity
  • schedule - Schedule
  • bulkaction - Bulk Action
Possible values:
entity_records_set_keystring · nullableOptional

Cache key from bulk action summary containing selected record IDs. Only for bulk action connectors.

execution_idstring · uuidRead-onlyRequired

ID of the created execution. Use it to monitor progress via the Execution Status API or to cancel the run via the Cancel Execution API.

post/api/smart-connectors/{connector_identifier}/start-connector-flow
200Success

Send webhook data

post

Send inbound webhook data to a Webhook SmartConnector's endpoint. The request body and query string are accepted as-is and queued for asynchronous processing; the connector run is created in the background. The response is returned immediately with an empty body and does not include an execution ID. Only connectors of type webhook accept requests at this endpoint, and the request body is limited to 250 KB and must be UTF-8 encoded.

Authorizations
X-API-KEYstringRequired
X-BUSINESS-IDstringRequired
X-USER-IDstringRequired
Path parameters
connector_identifierstringRequired
Query parameters
example_paramstringOptional

Example query parameter. Any query parameter is accepted.

Body
Other propertiesanyOptional
Responses
201

Webhook accepted and queued for asynchronous processing. The response body is empty.

No content
post/api/smart-connectors/{connector_identifier}/webhook
No content
PreviousS3NextTeam

Last updated

Was this helpful?