Skip to main content
POST
/
session
/
connect
Criar sessão
curl --request POST \
  --url https://apizap.loce.io/v1/session/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionName": "<string>",
  "webhookUrl": "<string>",
  "webhookMessages": true
}
'
{
  "sessionId": "<string>",
  "status": "<string>",
  "qrCode": "<string>",
  "webhookUrl": "<string>",
  "webhookMessages": true
}
POST /session/create 
import { LoceZap } from 'loce-zap-sdk';

const zap = new LoceZap({ apiKey: process.env.LOCE_ZAP_API_KEY! });

const { qrCode } = await zap.connect('my-session-id', {
  sessionName: 'Whatsapp do Zé',
  webhookUrl: 'https://example.com/webhook',
  webhookMessages: true, //Evento de mensagens (não disponível no plano free)
});

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sessionName
string
required

Nome amigável exibido no painel. Deve ser único por workspace.

​
webhookUrl
string<uri>
required

Endpoint HTTPS que receberá eventos da sessão.

​
webhookMessages
boolean

Ativa o envio de webhooks de mensagens (dependente do plano).

Response

Sessão criada com sucesso.

​
sessionId
string

Identificador único da sessão criada.

​
status
string

Estado atual da sessão (ex.: pending, connected).

​
qrCode
string

Payload do QR Code que deve ser renderizado para pareamento.

​
webhookUrl
string<uri>
​
webhookMessages
boolean