Skip to content

Chat

Channel chat.

Providers

providerIdCredentialsNotes
discordwebhook_url (secret)An incoming webhook. The webhook is both the secret and the destination.
telegrambot_token (secret)A bot.
slackbot_token (secret)A bot token, sent as a Bearer.
whatsappaccess_token (secret), phone_number_idWhatsApp Business (Meta Cloud).
mastodonbase_url, access_token, visibilityvisibility is public, unlisted, private or direct; empty means public.
blueskypds_url, identifier, app_passwordpds_url empty means https://bsky.social. identifier is the handle or DID. Use an app password, never the account password. Bluesky posts are public broadcasts.
chat-webhookwebhook_url, hmac_secret (secret, optional)The rendered message is POSTed as JSON.

Addressing

The subscriber’s address for a provider is stored under address:

curl -X PUT localhost:3000/v1/subscribers/user-1/credentials \
  -H "Authorization: ApiKey $KEY" -H 'Content-Type: application/json' \
  -d '{"providerId": "telegram", "channel": "chat", "credentials": {"address": "123456789"}}'
ProviderWhat address is
telegramThe chat id. Required: a subscriber with none is a permanent failure for the step.
discordOptional override of the destination webhook. Without it the integration’s webhook is used.
slack, whatsapp, mastodonThe recipient the provider addresses: a channel or user id, a phone number, an @handle.
blueskyNot used.

Telegram messages are sent with HTML parse mode, so inserted values are HTML-escaped; Slack messages are escaped for mrkdwn.

Two-way chat

Telegram and Discord can also be inbound: notify long-polls Telegram and holds a Discord gateway connection, routes what people say to an agent, and sends the reply back. That is configured with environment variables, not integrations: see Chat loop. Mastodon and Bluesky mention polling reads its credentials from the matching integration instead.

Legacy create

POST /v1/integrations/chat takes provider (discord, telegram, slack, whatsapp, mastodon, bluesky), identifier, primary, and webhookUrl, botToken, accessToken, phoneNumberId, baseUrl, visibility, pdsUrl, accountIdentifier, appPassword as needed.

Step options

body, integration. See the chat step.