Send message with the Webex API

Posts a message as the user in a space, or in a 1:1 space with the person of toPersonEmail, and returns it with its id. Send roomId or toPersonEmail, and text or markdown.

Identifier
webex_send_message

The request

POST https://connect.reportei.com/api/tools/webex_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "roomId": "<roomId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
roomIdstringNoId of the space, from List rooms or Create room.
toPersonEmailstringNoEmail address of a person, to send the message in a 1:1 space instead of roomId.
parentIdstringNoId of the message to reply to in a thread, from List messages or Send message.
textstringNoThe message in plain text, up to 7439 bytes. With markdown it is the fallback for clients without rich text.
markdownstringNoThe message in Markdown, up to 7439 bytes.
filesarrayNoPublic URL of one file to attach, such as a PDF or an image.

Supported connections

Your customer connects their Webex account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/webex, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/webex_send_message. It becomes your agent's tool definition with no conversion.

Other Webex tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.