Send a message

Send a message to a channel or conversation on a connected integration.

POST /actions/send_message

JavaScript

JavaScript

import Hyperspell from '@hyperspell/hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});

const response = await client.actions.sendMessage({ provider: 'reddit', text: 'text' });

console.log(response.provider_response);

200

{
  "success": true,
  "error": "<string>",
  "provider_response": {}
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Body

application/json

Send a message to a channel or conversation.

provider · enum<string> · required

Integration provider (e.g., slack)

Available options: reddit, notion, slack, google_calendar, google_mail, box, dropbox, github, google_drive, vault, web_crawler, trace, microsoft_teams, gmail_actions, granola, fathom, linear, hubspot, salesforce, coda

text · string · required

Message text

connection · string | null

Connection ID. If omitted, auto-resolved from provider + user.

channel · string | null

Channel ID (required for Slack)

parent · string | null

Parent message ID for threading (thread_ts for Slack)

Response

200

application/json

Successful Response

Result from executing an integration action.

success · boolean · required

error · string | null

provider_response · Provider Response · object