Overview

The Chat API enables you to send messages programmatically to team chats, channels, and private conversations. Integrate with your systems to automate notifications, alerts, and communications.

Key Concepts

Conversations

Conversations are chat threads in Connecteam. There are two types:

Type	Description
`team`	Team chat with multiple members
`channel`	Broadcast channel for announcements

Custom Publishers

Custom publishers are bot-like senders that can post messages via the API. They appear as the message author instead of a user.

📝
Setting Up Custom Publishers
Custom publishers must be configured in the Connecteam UI:

Go to Settings → Feed settings

Create a new custom publisher

Note the publisher ID to use as senderId in API calls

Private vs Non-Private Conversations

Non-private: Team chats and channels - can be listed via GET endpoint
Private: Direct messages between users - not listed, but you can send to them

Available Endpoints

Method	Endpoint	Description
GET	/chat/v1/conversations	Get team chats and channels
POST	/chat/v1/conversations/{conversationId}/message	Send message to conversation
POST	/chat/v1/conversations/privateMessage/{userId}	Send private message to user

Constraints

Constraint	Value
Max message length	1000 characters
Max conversations per page	100
Attachment types	`image`, `file`
Multiple non-image attachments	Not allowed

Authentication

All endpoints require authentication via API key or OAuth 2.0.

Required Scopes

Scope	Operations
chat.read	GET conversations
chat.write	POST messages

Attachments

To send attachments with messages:

Upload the file using the Attachments API with featureType: chat
Get the fileId from the upload response
Include the attachment in your message request

⚠️
Attachment Rules

Multiple image attachments are allowed

Only one non-image file attachment is allowed per message

Files must be uploaded via Attachments API first

Guide Pages

Page	Description
Conversations	List and send messages to team chats and channels
Private Messages	Send direct messages to users
Custom Publishers	Configure bot senders for API messages

API Reference