Skip to main content

Send a typing indicator

POST 
/chat.typing

Notify other chat participants that you are working on a response. If they have the chat open, they will see "(Bot name) is typing...".

The indicator lasts 6 seconds. Re-send every 5 seconds to keep it visible while you work. Longer gaps will let it expire between pings.

Destination options (mutually exclusive):

  • chatId - Send to an existing chat by its ID
  • groupId - Send to a group channel
  • userIds - Send to a DM or Multi-DM with the specified users

Custom sender (optional): pass sender.id to show the indicator as a configured bot persona — the persona's configured name and avatar are used. Only id is accepted; name and imageUrl are rejected on this endpoint. Selection is lookup-only: an id that doesn't match a configured persona is accepted and ignored, and the indicator shows the app's own identity (same for an omitted, empty, or _ id). Personal access tokens reject sender entirely.

Required scope: chat:send_message or chat:write

OpenAPI Spec: chat-v1.json

Request​

Responses​

Typing indicator successfully sent