Appearance
slack.workspace.sync ​
Sync a Slack workspace (channels + users + user groups) into the platform DB.
Sync a Slack workspace's channels, users, and user groups into the DB.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Dag |
| Library | App-slack |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | DAG-stamped parent run id (auto-injected by the engine) |
organization_uuid | uuid | Yes | — | Organization that owns the Slack connection |
connection_uuid | uuid | Yes | — | Slack CloudConnection UUID |
include_private | boolean | No | — | Include private channels (default true) |
include_im | boolean | No | — | Include im/mpim conversations (default false) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_uuid | uuid | No | — | — |
organization_uuid | json | No | — | — |
connection_uuid | json | No | — | — |
include_private | json | No | — | — |
include_im | json | No | — | — |
channels | json | No | — | — |
users | json | No | — | — |
usergroups | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
failed_at_state | string | No | — | — |
failed_layer | json | No | — | — |
failed_step | string | No | — | — |
failure_reason | string | No | — | — |
compensation_trigger | json | No | — | — |
comp_queue | json | No | — | — |
comp_current_layer | json | No | — | — |
comp_retry_count | json | No | — | — |
DAG Layers ​
| # | Layer | Steps | Compensation |
|---|---|---|---|
| 1 | sync | slack.channels.sync, slack.users.sync, slack.usergroups.sync | — |
Execution Flow ​
Sub-workflows ​
| Sub-workflow | Step name |
|---|---|
slack.channels.sync | channels |
slack.users.sync | users |
slack.usergroups.sync | usergroups |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "slack.workspace.sync",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value"
}
}