La referencia de la API se publica en inglés.

Connect the current user's Slack identity and send a test DM

POST/api/chat-endpoints/{endpointId}/slack/test-message
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Connect the current user's Slack identity and send a test DM.

Requires a board connection manager and active organization membership. Reuses only the actor's verified identity in the same workspace; otherwise returns paginated account choices and sends a private connection challenge. The account holder must confirm it while signed in before linking or test delivery. Revoked and conflicting links cannot be overwritten. The request ID prevents duplicate or ambiguous sends from being replayed.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

endpointIdstring (uuid)ObligatorioThe endpoint's id.

Cuerpo de la solicitud

application/json · obligatorio

requestIdstring (uuid)Obligatorio
slackUserIdstringOpcionalpattern: ^[UW][A-Z0-9]+$
accountCursorstringOpcional1–512 characters

Respuestas

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
429Wait before sending another test messageToo many requests; wait for Retry-After seconds.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Chat channels