TalkJS

TalkJS is a chat API and SDK for adding messaging to web and mobile apps. It pairs a customizable pre-built chat UI (the TalkJS JavaScript SDK and Chat UI) with a server-side REST API at https://api.talkjs.com/v1/{appId} for managing users, conversations, participants, and messages, importing existing chat history, and receiving events via webhooks.

5 APIs 0 Features

ChatMessagingCommunicationSDKWebhooks

APIs

TalkJS Users API

Create, update, and retrieve TalkJS users, list users and a user's conversations, and manage per-user presence. Users are timeless resources upserted with PUT and updated PATCH-...

TalkJS Conversations & Participants API

Create, update, list, and delete conversations, and manage their participants - join (PUT), leave (DELETE), and set access (ReadWrite/Read) and notification preferences. Include...

TalkJS Messages API

Send, list, fetch, edit, and delete messages in a conversation, including UserMessage and SystemMessage types, replies via referencedMessageId, idempotency keys, and emoji react...

TalkJS Import API

Import existing chat history with original timestamps via the special importing resource, used after upserting users and conversations to migrate from other chat providers into ...

TalkJS Webhooks API

Server-to-server event delivery for message.sent, message.read, message.updated, message.deleted, user.created/updated, conversation.deleted, and notification lifecycle events, ...

Collections

TalkJS REST API

OPEN

Pricing Plans

Talkjs Plans Pricing

3 plans

PLANS

Rate Limits

Talkjs Rate Limits

5 limits

RATE LIMITS

FinOps

Talkjs Finops

FINOPS

Resources

VulnerabilityDisclosure

VulnerabilityDisclosure

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: TalkJS REST API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Create or update a user
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/users/{{userId}}
      body:
        type: json
        data: '{"name": "<string>", "email": ["<string>"], "photoUrl": "<string>", "role": "<string>", "welcomeMessage": "<string>",
          "custom": {}}'
    docs: Create or update a user
  - info:
      name: Batch create or update users
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/users
      body:
        type: json
        data: '{"<userId>": {"name": "<string>", "role": "<string>"}}'
    docs: Batch create or update users
  - info:
      name: Retrieve a user
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/users/{{userId}}
    docs: Retrieve a user
  - info:
      name: List users
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/users
    docs: List users
  - info:
      name: List a user's conversations
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/users/{{userId}}/conversations
    docs: List a user's conversations
  - info:
      name: Get user presence
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/users/{{userId}}/presence
    docs: Get user presence
  - info:
      name: Set user presence
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/users/{{userId}}/presence
      body:
        type: json
        data: '{"visible": true, "availability": "online"}'
    docs: Set user presence
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: List conversations
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/conversations
    docs: List conversations
  - info:
      name: Retrieve a conversation
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}
    docs: Retrieve a conversation
  - info:
      name: Create or update a conversation
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}
      body:
        type: json
        data: '{"subject": "<string>", "photoUrl": "<string>", "welcomeMessages": ["<string>"], "custom": {}, "participants":
          ["<userId>"]}'
    docs: Create or update a conversation
  - info:
      name: Delete a conversation
      type: http
    http:
      method: DELETE
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}
    docs: Delete a conversation
  - info:
      name: Mark a conversation read or unread
      type: http
    http:
      method: PATCH
      url: https://api.talkjs.com/v1/{{appId}}/users/{{userId}}/conversations/{{conversationId}}
      body:
        type: json
        data: '{"readUntil": "sent"}'
    docs: Mark a conversation read or unread
- info:
    name: Participants
    type: folder
  items:
  - info:
      name: Add or update a participant
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/participants/{{userId}}
      body:
        type: json
        data: '{"access": "ReadWrite", "notify": true}'
    docs: Add or update a participant
  - info:
      name: Remove a participant
      type: http
    http:
      method: DELETE
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/participants/{{userId}}
    docs: Remove a participant
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: List messages
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages
    docs: List messages
  - info:
      name: Send messages
      type: http
    http:
      method: POST
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages
      body:
        type: json
        data: '[{"type": "UserMessage", "text": "<string>", "sender": "<userId>", "custom": {}}]'
    docs: Send messages
  - info:
      name: Retrieve a message
      type: http
    http:
      method: GET
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages/{{messageId}}
    docs: Retrieve a message
  - info:
      name: Edit a message
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages/{{messageId}}
      body:
        type: json
        data: '{"text": "<string>", "custom": {}}'
    docs: Edit a message
  - info:
      name: Delete a message
      type: http
    http:
      method: DELETE
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages/{{messageId}}
    docs: Delete a message
  - info:
      name: Add an emoji reaction
      type: http
    http:
      method: PUT
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages/{{messageId}}/reactions/{{emoji}}/{{userId}}
    docs: Add an emoji reaction
  - info:
      name: Remove an emoji reaction
      type: http
    http:
      method: DELETE
      url: https://api.talkjs.com/v1/{{appId}}/conversations/{{conversationId}}/messages/{{messageId}}/reactions/{{emoji}}/{{userId}}
    docs: Remove an emoji reaction
- info:
    name: Import
    type: folder
  items:
  - info:
      name: Import messages with timestamps
      type: http
    http:
      method: POST
      url: https://api.talkjs.com/v1/{{appId}}/import/conversations/{{conversationId}}/messages
      body:
        type: json
        data: '[{"type": "UserMessage", "text": "<string>", "sender": "<userId>", "createdAt": 0}]'
    docs: Import messages with timestamps
  - info:
      name: Execute a batch of operations
      type: http
    http:
      method: POST
      url: https://api.talkjs.com/v1/{{appId}}/batch
      body:
        type: json
        data: '[]'
    docs: Execute a batch of operations