Skip to content
Proud to collaborate with Microsoft for Startups

slack.channels.sync ​

Sync Slack conversations (channels/groups/mpim/im) for one connection into the DB.

Sync Slack conversations (public/private channels, mpim, im) into slack_channel.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-slack
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization that owns the Slack connection
connection_uuiduuidYes—Slack CloudConnection UUID
include_privatebooleanNo—Include private channels (needs groups:read); default true
include_imbooleanNo—Include im/mpim conversations (needs im:read/mpim:read); default false
workflow_run_idstringNo—Parent DAG run id (auto-injected by the engine when used as a DAG step)

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization echoed from input
connection_uuiduuidNo—Slack connection echoed from input
team_idstringNo—Slack team id
discoveredintegerNo—Remote records discovered before persistence
syncedintegerNo—Valid records processed by persistence
insertedintegerNo—Rows inserted during this sync
updatedintegerNo—Existing rows whose persisted fields changed
unchangedintegerNo—Existing rows already matching the remote record
deletedintegerNo—Remote records marked deleted or archived
error_countintegerNo—Records skipped because they could not be persisted
errorslistNo—Per-record persistence errors
paginationjsonNo—Pagination metadata for the fully enumerated Slack API read
include_privatebooleanNo—Private-channel sync flag used
include_imbooleanNo—IM/MPIM sync flag used
workflow_run_idstringNo—Parent DAG run id (auto-injected by the engine when used as a DAG step)
failure_reasonstringNo—Human-readable failure reason (engine-stamped)
failure_typestringNo—Failure category (engine-stamped)
failed_actionstringNo—Action that failed (engine-stamped)
failed_at_statestringNo—State where the workflow failed (engine-stamped)
failed_stepstringNo—DAG step that failed (engine-stamped)
failed_layerstringNo—DAG layer that failed (engine-stamped)
errorstringNo—Error message (engine-stamped)
error_typestringNo—Error class name (engine-stamped)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "slack.channels.sync",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value"
  }
}