Skip to main content

Connect consumer

POST /api/connectors/consumer
FieldTypeRequiredDescription
typestringYesConsumer type: slack, api, whatsapp, claude-code
workspace_idstringYesTarget workspace
credentialsobjectYesType-specific credentials
channel_idstringNoOptional initial channel to bind

Slack credentials

{
  "type": "slack",
  "workspace_id": "ws-example",
  "credentials": {
    "bot_token": "xoxb-...",
    "app_token": "xapp-..."
  }
}
Response:
{"status": "connected", "message": "Slack consumer connected and started."}

Bind channel

POST /api/connectors/consumer/channel
FieldTypeRequiredDescription
typestringYesConsumer type
workspace_idstringYesTarget workspace
channel_idstringYesExternal channel identifier
channel_namestringNoDisplay name (e.g. #support)
Response:
{"status": "saved", "message": "Channel #support-assist bound to this workspace."}
Error (duplicate binding):
{
  "error": "This channel is already bound to \"HR Assistant\". A channel can only belong to one workspace."
}