Skip to main content
POST
/
api
/
sessions
curl -X POST "https://api.oxenty.api.br/api/sessions" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "atendimento-principal",
    "allowGroup": true,
    "webhookUrl": "https://seu-servidor.com/webhook",
    "webhookEvents": ["message.received", "message.status"]
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "atendimento-principal",
  "status": "disconnected",
  "allowGroup": true,
  "webhookUrl": "https://seu-servidor.com/webhook",
  "webhookEvents": ["message.received", "message.status"],
  "hasWebhook": true,
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-01-15T10:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oxenty.api.br/llms.txt

Use this file to discover all available pages before exploring further.

Cria uma nova sessão que pode ser conectada a uma conta do WhatsApp.
A sessão é criada com status disconnected. Você precisa chamar o endpoint de conectar para obter o QR Code.

​
Request Body

​
name
string
required
Nome identificador da sessão. Deve ser único dentro do tenant.Exemplo: "atendimento-principal"
​
allowGroup
boolean
default:"true"
Se a sessão deve processar mensagens de grupos.
​
webhookUrl
string
URL que receberá eventos via webhook (HTTPS obrigatório em produção).Exemplo: "https://seu-servidor.com/webhook"
​
webhookEvents
string[]
Lista de eventos que o webhook receberá. Se não especificado, recebe todos.Valores possíveis:
  • message.received
  • message.sent
  • message.status
  • session.connected
  • session.disconnected
​
webhookSecret
string
Secret para validação de assinatura dos webhooks.

​
Resposta

​
id
string
ID único da sessão (UUID).
​
name
string
Nome da sessão.
​
status
string
Status atual da sessão (disconnected).
​
allowGroup
boolean
Se mensagens de grupo estão habilitadas.
​
webhookUrl
string
URL do webhook configurado.
​
hasWebhook
boolean
Se há webhook configurado.
​
createdAt
string
Data de criação (ISO 8601).
curl -X POST "https://api.oxenty.api.br/api/sessions" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "atendimento-principal",
    "allowGroup": true,
    "webhookUrl": "https://seu-servidor.com/webhook",
    "webhookEvents": ["message.received", "message.status"]
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "atendimento-principal",
  "status": "disconnected",
  "allowGroup": true,
  "webhookUrl": "https://seu-servidor.com/webhook",
  "webhookEvents": ["message.received", "message.status"],
  "hasWebhook": true,
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-01-15T10:00:00.000Z"
}