Skip to content

Gateways API

Manage communication gateways.

Endpoints

MethodEndpointDescription
GET/api/agents/{id}/gatewaysList gateways
POST/api/agents/{id}/gatewaysCreate gateway
GET/api/agents/{id}/gateways/{gatewayId}Get gateway
PUT/api/agents/{id}/gateways/{gatewayId}Update gateway
DELETE/api/agents/{id}/gateways/{gatewayId}Delete gateway

List Gateways

bash
GET /api/agents/{id}/gateways

Response

json
{
  "gateways": [
    {
      "id": "gateway-123",
      "type": "telegram",
      "name": "Support Bot",
      "is_default": true,
      "status": "active"
    }
  ]
}

Create Gateway

bash
POST /api/agents/{id}/gateways
Content-Type: application/json

Request Body

json
{
  "type": "telegram",
  "name": "Support Bot",
  "config": {
    "bot_token": "123456:ABC..."
  },
  "is_default": true
}

Update Gateway

bash
PUT /api/agents/{id}/gateways/{gatewayId}

Delete Gateway

bash
DELETE /api/agents/{id}/gateways/{gatewayId}

Gateway Types

TypeDescription
emailSMTP email
telegramTelegram bot
slackSlack app
discordDiscord bot
whatsappWhatsApp Business
smsSMS via Twilio
webhookCustom webhook

Released under the MIT License.