Chat SDK

Emoji

The emoji helper gives you named emoji that convert to each platform's format when posted. On Slack, they render as :shortcode: text. On other platforms, they render as Unicode characters.

Usage

lib/bot.ts
import { emoji } from "chat";

await thread.post(`${emoji.thumbs_up} Great job!`);
// Slack: ":+1: Great job!"
// Teams/GChat/Discord: "👍 Great job!"

Emoji also work in reactions:

lib/bot.ts
await sent.addReaction(emoji.check);

bot.onReaction(["thumbs_up", "heart", "fire"], async (event) => {
  if (!event.added) return;
  await event.adapter.addReaction(event.threadId, event.messageId, emoji.raised_hands);
});

Available emoji

NameEmojiNameEmoji
emoji.thumbs_up👍emoji.thumbs_down👎
emoji.heart❤️emoji.smile😊
emoji.laugh😂emoji.thinking🤔
emoji.eyes👀emoji.fire🔥
emoji.check✅emoji.x❌
emoji.question❓emoji.party🎉
emoji.rocket🚀emoji.star⭐
emoji.wave👋emoji.clap👏
emoji["100"]💯emoji.warning⚠️
emoji.raised_hands🙌emoji.muscle💪
emoji.ok_hand👌emoji.sad😢
emoji.memo📝emoji.gear⚙️
emoji.wrench🔧emoji.bug🐛
emoji.calendar📅emoji.clock🕐
emoji.sun☀️emoji.rainbow🌈

For a one-off custom emoji, use emoji.custom("name").

Custom emoji

For workspace-specific emoji with typed names, use createEmoji():

lib/bot.ts
import { createEmoji } from "chat";

const myEmoji = createEmoji({
  unicorn: { slack: "unicorn_face", gchat: "🦄" },
  company_logo: { slack: "company", gchat: "🏢" },
});

await thread.post(`${myEmoji.unicorn} Magic! ${myEmoji.company_logo}`);
// Slack: ":unicorn_face: Magic! :company:"
// GChat: "🦄 Magic! 🏢"

You can also extend the built-in emoji map with TypeScript module augmentation:

lib/emoji.d.ts
declare module "chat" {
  interface CustomEmojiMap {
    my_custom: EmojiFormats;
  }
}

Read more

Posting Messages

Different ways to render and send messages with thread.post().

Cards

Send rich interactive cards with buttons, fields, and images across all platforms.

Handling Events

Register handlers for mentions, messages, reactions, member joins, and platform-specific events.

Modals

Collect structured user input through modal dialogs with text fields, dropdowns, and validation.

PreviousSlash CommandsNextOverview