API reference
Messaging activities
Slack, Microsoft Teams, Google Chat, Telegram, WhatsApp and Facebook Messenger.
Slack, Microsoft Teams, Google Chat, Telegram, WhatsApp and Facebook Messenger. This page covers 6 activity types.
google_chat#
Google Chat. Send messages to Google Chat via Incoming Webhooks or the Chat REST API. Supports plain text, Card v2 messages, space creation, and space retrieval.
Operations: send_message, send_card, create_space, get_space. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
webhookUrl |
string | No | [send_message / send_card] Incoming Webhook URL from the Google Chat space settings Used when operation is send_message, send_card. Secret: stored encrypted. |
accessToken |
string | No | [create_space / get_space] OAuth 2.0 access token — override the config-block value at runtime Used when operation is create_space, get_space. Secret: stored encrypted. |
serviceAccountJson |
string | No | [create_space / get_space] Full service account JSON for automatic JWT token exchange Used when operation is create_space, get_space. Secret: stored encrypted. |
text |
string | No | [send_message] Plain text message body Used when operation is send_message. |
cardJson |
string | No | [send_card] Card v2 JSON object (see Google Chat Card reference) Used when operation is send_card. |
spaceId |
string | No | [get_space] Google Chat space resource name (e.g. spaces/XXXXXXXX) Used when operation is get_space. |
spaceName |
string | No | [create_space] Display name for the new space (default: New Space) Used when operation is create_space. |
spaceType |
string | No | [create_space] Space type: SPACE | GROUP_CHAT | DIRECT_MESSAGE (default: SPACE) Used when operation is create_space. Allowed values: SPACE, GROUP_CHAT, DIRECT_MESSAGE. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | True if the webhook or API call succeeded |
output.messageId |
string | Resource name of the message (e.g. spaces/X/messages/Y) |
output.spaceId |
string | [create_space / get_space] Resource name of the space |
output.statusCode |
number | HTTP status code of the API response |
output.response |
string | Raw JSON response body from the API |
Config block example:
{
"google_chat": {
"operation": "send_message",
"webhookUrl": "https://chat.googleapis.com/v1/spaces/XXX/messages?key=...&token=..."
}
}
messenger#
Facebook Messenger. Send messages via the Facebook Messenger Platform API. Supports text messages, approved templates, media attachments, and user profile retrieval.
Operations: send_message, send_template, send_media, get_profile. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
pageAccessToken |
string | No | Facebook Page Access Token — override the config-block value at runtime Secret: stored encrypted. |
recipientId |
string | No | [send_message / send_template / send_media] Recipient Page-Scoped User ID (PSID) Used when operation is send_message, send_template, send_media. |
text |
string | No | [send_message] Text message body Used when operation is send_message. |
templateJson |
string | No | [send_template] Messenger template payload JSON (template_type, elements, buttons, etc.) Used when operation is send_template. |
attachmentType |
string | No | [send_media] Attachment type: image | video | audio | file (default: image) Used when operation is send_media. Allowed values: image, video, audio, file. |
attachmentUrl |
string | No | [send_media] Public URL of the media file Used when operation is send_media. |
userId |
string | No | [get_profile] User ID to retrieve profile for Used when operation is get_profile. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | True if the API call succeeded |
output.messageId |
string | Messenger message_id returned by the API |
output.recipientId |
string | Recipient PSID confirmed by the API |
output.statusCode |
number | HTTP status code of the API response |
output.response |
string | Raw JSON response body from the API |
Config block example:
{
"messenger": {
"operation": "send_message",
"pageAccessToken": "YOUR_PAGE_ACCESS_TOKEN"
}
}
slack#
Slack. Interact with Slack via the Web API. Post messages, send Block Kit layouts, upload files, add emoji reactions, and look up users.
Operations: send_message, send_blocks, update_message, upload_file, add_reaction, get_user. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
botToken |
string | No | Slack Bot Token (xoxb-...) — override the config-block value at runtime Secret: stored encrypted. |
channel |
string | No | Channel ID or name (e.g. #general or C0123ABC) |
text |
string | No | [send_message / send_blocks / update_message] Message text (markdown supported) Used when operation is send_message, send_blocks, update_message. |
username |
string | No | [send_message] Override the bot username Used when operation is send_message. |
iconEmoji |
string | No | [send_message] Override the bot icon emoji (e.g. :robot_face:) Used when operation is send_message. |
blocksJson |
string | No | [send_blocks] JSON array of Block Kit blocks Used when operation is send_blocks. |
timestamp |
string | No | [update_message / add_reaction] Message timestamp (ts) to target Used when operation is update_message, add_reaction. |
emojiName |
string | No | [add_reaction] Emoji name without colons (e.g. thumbsup) Used when operation is add_reaction. |
email |
string | No | [get_user] User email address to look up Used when operation is get_user. |
fileName |
string | No | [upload_file] File name including extension Used when operation is upload_file. |
fileContent |
string | No | [upload_file] Plain-text file content to upload Used when operation is upload_file. |
fileType |
string | No | [upload_file] Slack file type hint (default: text) Used when operation is upload_file. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | True when Slack returns ok:true |
output.messageId |
string | Message timestamp (ts) acting as a unique identifier |
output.timestamp |
string | Message timestamp (ts) |
output.fileId |
string | [upload_file] Slack file ID |
output.statusCode |
number | HTTP status code of the API response |
output.response |
string | Raw JSON response body from the API |
Config block example:
{
"slack": {
"operation": "send_message",
"botToken": "xoxb-YOUR-BOT-TOKEN",
"channel": "#alerts"
}
}
teams#
Microsoft Teams. Send messages to Microsoft Teams via Incoming Webhooks or the Microsoft Graph API. Supports plain text, Adaptive Cards, channel messages, and meeting creation.
Operations: send_message, send_adaptive_card, create_channel_message, create_meeting. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
webhookUrl |
string | No | [send_message / send_adaptive_card] Incoming Webhook URL from the Teams channel connector Used when operation is send_message, send_adaptive_card. Secret: stored encrypted. |
text |
string | No | [send_message / create_channel_message] Message text (HTML supported) Used when operation is send_message, create_channel_message. |
title |
string | No | [send_message] Optional card title Used when operation is send_message. |
themeColor |
string | No | [send_message] Accent color hex code (default: 0078D4) Used when operation is send_message. |
adaptiveCardJson |
string | No | [send_adaptive_card] Adaptive Card JSON payload (card schema v1.3+) Used when operation is send_adaptive_card. |
tenantId |
string | No | [create_channel_message / create_meeting] Azure AD tenant ID Used when operation is create_channel_message, create_meeting. |
clientId |
string | No | [create_channel_message / create_meeting] Azure AD app client ID Used when operation is create_channel_message, create_meeting. |
clientSecret |
string | No | [create_channel_message / create_meeting] Azure AD app client secret Used when operation is create_channel_message, create_meeting. Secret: stored encrypted. |
teamId |
string | No | [create_channel_message] Teams team ID Used when operation is create_channel_message. |
channelId |
string | No | [create_channel_message] Teams channel ID Used when operation is create_channel_message. |
subject |
string | No | [create_meeting] Meeting subject (default: New Meeting) Used when operation is create_meeting. |
startDateTime |
string | No | [create_meeting] Meeting start time in ISO 8601 UTC format Used when operation is create_meeting. |
endDateTime |
string | No | [create_meeting] Meeting end time in ISO 8601 UTC format Used when operation is create_meeting. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | True if the webhook or Graph API call succeeded |
output.messageId |
string | Graph API message or meeting ID (Graph operations only) |
output.meetingUrl |
string | [create_meeting] Teams meeting join URL |
output.statusCode |
number | HTTP status code of the API response |
output.response |
string | Raw JSON response body from the API |
Config block example:
{
"teams": {
"operation": "send_message",
"webhookUrl": "https://xxx.webhook.office.com/webhookb2/..."
}
}
telegram#
Telegram. Interact with Telegram via the Bot API. Send text, photos, documents, and polls; pin messages; and retrieve chat information.
Operations: send_message, send_photo, send_document, send_poll, pin_message, get_chat. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
botToken |
string | No | Telegram Bot API token — override the config-block value at runtime Secret: stored encrypted. |
chatId |
string | Yes | Target chat ID or @channelname |
text |
string | No | [send_message] Message text Used when operation is send_message. |
parseMode |
string | No | [send_message / send_photo / send_document] Text formatting: Markdown | HTML | MarkdownV2 Used when operation is send_message, send_photo, send_document. Allowed values: Markdown, HTML, MarkdownV2. |
photoUrl |
string | No | [send_photo] Public URL of the photo Used when operation is send_photo. |
documentUrl |
string | No | [send_document] Public URL of the document Used when operation is send_document. |
caption |
string | No | [send_photo / send_document] Optional caption Used when operation is send_photo, send_document. |
question |
string | No | [send_poll] Poll question text Used when operation is send_poll. |
pollOptionsJson |
string | No | [send_poll] JSON array of option strings Used when operation is send_poll. |
isAnonymous |
boolean | No | [send_poll] Whether the poll is anonymous (default: true) Used when operation is send_poll. |
pollType |
string | No | [send_poll] Poll type: regular | quiz (default: regular) Used when operation is send_poll. Allowed values: regular, quiz. |
messageId |
string | No | [pin_message] ID of the message to pin Used when operation is pin_message. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | True when the Bot API returns ok:true |
output.messageId |
string | Telegram message_id of the sent or pinned message |
output.statusCode |
number | HTTP status code of the API response |
output.response |
string | Raw JSON response body from the Bot API |
Config block example:
{
"telegram": {
"operation": "send_message",
"botToken": "YOUR_BOT_TOKEN"
}
}
whatsapp#
WhatsApp. Send messages via the WhatsApp Business Cloud API. Supports text, approved templates, media (image/video/audio/document), interactive messages, reactions, and read receipts.
Operations: send_message, send_template, send_media, send_interactive, send_reaction, mark_read. Set with the operation input.
| Input | Type | Required | Description |
|---|---|---|---|
to |
string | Yes | Recipient WhatsApp phone number in international format (e.g. +14155552671) |
accessToken |
string | No | Meta access token — override the config-block value at runtime Secret: stored encrypted. |
phoneNumberId |
string | No | WhatsApp Business phone number ID — override the config-block value at runtime |
text |
string | No | [send_message] Message body text Used when operation is send_message. |
templateName |
string | No | [send_template] Approved template name Used when operation is send_template. |
languageCode |
string | No | [send_template] BCP-47 language code (default: en_US) Used when operation is send_template. |
templateParamsJson |
string | No | [send_template] JSON array of component parameter objects Used when operation is send_template. |
mediaUrl |
string | No | [send_media] Public URL of the media file Used when operation is send_media. |
mediaType |
string | No | [send_media] Media type: image | video | audio | document (default: image) Used when operation is send_media. Allowed values: image, video, audio, document. |
caption |
string | No | [send_media] Optional caption for the media Used when operation is send_media. |
interactiveJson |
string | No | [send_interactive] Full interactive message payload JSON Used when operation is send_interactive. |
messageId |
string | No | [send_reaction / mark_read] ID of the message to act on Used when operation is send_reaction, mark_read. |
emoji |
string | No | [send_reaction] Emoji character to react with (default: 👍) Used when operation is send_reaction. |
| Output | Type | Description |
|---|---|---|
output.success |
boolean | True if the API call succeeded |
output.messageId |
string | WhatsApp message ID (wamid) returned by the API |
output.statusCode |
number | HTTP status code of the API response |
output.response |
string | Raw JSON response body from the API |
Config block example:
{
"whatsapp": {
"operation": "send_message",
"phoneNumberId": "YOUR_PHONE_NUMBER_ID",
"accessToken": "YOUR_ACCESS_TOKEN"
}
}