Webhooks

Listar eventos

get

Listagem dos eventos de webhook que podem ser assinados.

Autorizações
Respostas
200

Success

application/json
get
/v1/webhook/event
GET /core/v1/webhook/event HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "event": "SESSION_NEW",
    "description": "text"
  }
]

Listar assinaturas

get

Listagem das assinaturas de webhook ativas e inativas.

Autorizações
Respostas
200

Success

application/json
get
/v1/webhook/subscription
GET /core/v1/webhook/subscription HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-11-06T22:36:38.254Z",
    "updatedAt": "2025-11-06T22:36:38.254Z",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "url": "text",
    "enabled": true,
    "events": [
      {
        "event": "SESSION_NEW",
        "description": "text"
      }
    ]
  }
]

Cria assinatura

post

Cria assinatura de webhook.

Autorizações
Corpo
namestring · mín: 1 · máx: 100Obrigatório

Nome para identificação da assinatura

urlstring · mín: 1 · máx: 500Obrigatório

URL destino para onde serão enviadas requisições POST

enabledboolean | nuloOpcional

Estado inicial da assinatura (ativa ou inativa)

Default: true
Respostas
200

Success

application/json
post
/v1/webhook/subscription
POST /core/v1/webhook/subscription HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "name": "text",
  "url": "text",
  "enabled": true,
  "events": [
    "SESSION_NEW"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "url": "text",
  "enabled": true,
  "events": [
    {
      "event": "SESSION_NEW",
      "description": "text"
    }
  ]
}

Busca assinatura por ID

get

Busca assinatura de webhook através do ID.

Autorizações
Parâmetros de rota
subscriptionIdstring · uuidObrigatório

ID da assinatura de webhook.

Respostas
200

Success

application/json
get
/v1/webhook/subscription/{subscriptionId}
GET /core/v1/webhook/subscription/{subscriptionId} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "url": "text",
  "enabled": true,
  "events": [
    {
      "event": "SESSION_NEW",
      "description": "text"
    }
  ]
}

Atualiza assinatura

put

Atualiza assinatura de webhook.

Autorizações
Parâmetros de rota
subscriptionIdstring · uuidObrigatório

ID da assinatura de webhook.

Corpo
namestring | nuloOpcional

Nome para identificação da assinatura.

urlstring | nuloOpcional

URL destino para onde serão enviadas requisições POST.

enabledboolean | nuloOpcional

Estado inicial da assinatura (ativa ou inativa).

Default: true
Respostas
200

Success

application/json
put
/v1/webhook/subscription/{subscriptionId}
PUT /core/v1/webhook/subscription/{subscriptionId} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "fields": [
    "Name"
  ],
  "name": "text",
  "url": "text",
  "enabled": true,
  "events": [
    "SESSION_NEW"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:36:38.254Z",
  "updatedAt": "2025-11-06T22:36:38.254Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "url": "text",
  "enabled": true,
  "events": [
    {
      "event": "SESSION_NEW",
      "description": "text"
    }
  ]
}

Remove assinatura

delete

Remove assinatura de webhook.

Autorizações
Parâmetros de rota
subscriptionIdstring · uuidObrigatório

ID da assinatura de webhook.

Respostas
200

Success

Sem conteúdo
delete
/v1/webhook/subscription/{subscriptionId}
DELETE /core/v1/webhook/subscription/{subscriptionId} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo

Atualizado