For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rocketchat Configuration

Get All Rocketchat Configs

get

Get all RocketChat configurations.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses
200

Successful Response

application/json
server_urlstringRequired
room_namestringRequired
usernamestringRequired
passwordstringRequired
idintegerRequired
created_atstring · date-timeRequired
get/api/v1/rocketchat-configuration
GET /api/v1/rocketchat-configuration HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful Response

[
  {
    "server_url": "text",
    "room_name": "text",
    "username": "text",
    "password": "text",
    "id": 1,
    "created_at": "2026-01-01T00:00:00.000Z"
  }
]

Create Rocketchat Config

post

Create a new RocketChat configuration.

Validates credentials, resolves the room, stores the config, and picks it up in the realtime subscriber. Messages are received over the outbound realtime websocket — no webhook registration is needed.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
server_urlstringRequired
room_namestringRequired
usernamestringRequired
passwordstringRequired
Responses
200

Successful Response

application/json
server_urlstringRequired
room_namestringRequired
usernamestringRequired
passwordstringRequired
idintegerRequired
created_atstring · date-timeRequired
post/api/v1/rocketchat-configuration
POST /api/v1/rocketchat-configuration HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "server_url": "text",
  "room_name": "text",
  "username": "text",
  "password": "text"
}
{
  "server_url": "text",
  "room_name": "text",
  "username": "text",
  "password": "text",
  "id": 1,
  "created_at": "2026-01-01T00:00:00.000Z"
}

Get Rocketchat Config

get

Get a specific RocketChat configuration.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
config_idintegerRequired
Responses
200

Successful Response

application/json
server_urlstringRequired
room_namestringRequired
usernamestringRequired
passwordstringRequired
idintegerRequired
created_atstring · date-timeRequired
get/api/v1/rocketchat-configuration/{config_id}
GET /api/v1/rocketchat-configuration/{config_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "server_url": "text",
  "room_name": "text",
  "username": "text",
  "password": "text",
  "id": 1,
  "created_at": "2026-01-01T00:00:00.000Z"
}

Delete Rocketchat Config

delete

Delete a RocketChat configuration.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
config_idintegerRequired
Responses
200

Successful Response

application/json
anyOptional
delete/api/v1/rocketchat-configuration/{config_id}
DELETE /api/v1/rocketchat-configuration/{config_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Test Webhook

post

Manually trigger a webhook test by sending a test message.

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
config_idintegerRequired
Responses
200

Successful Response

application/json
anyOptional
post/api/v1/rocketchat-configuration/{config_id}/test-webhook
POST /api/v1/rocketchat-configuration/{config_id}/test-webhook HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated