Listar Webhooks

Metodo

GET https://oapi.ogmma.com.br/v1/webhooks

Conceituacao

Este endpoint retorna a lista de todos os webhooks configurados para a sua instituicao. A resposta inclui informacoes como nome, URL de destino, eventos monitorados, status de ativacao e o numero de falhas consecutivas de entrega.

Utilize este endpoint para monitorar o estado dos seus webhooks e identificar possiveis problemas de entrega.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Chave de autenticacao da API. Bearer {API_KEY}

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/webhooks" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/webhooks',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/webhooks',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Lista de webhooks retornada com sucesso

{
  "data": [
    {
      "id": "665f1a2b3c4d5e6f7a8b9c0d",
      "name": "Notificacoes de Mensagens",
      "url": "https://meuservidor.com.br/webhooks/ogmma",
      "events": [
        "message.received",
        "message.sent",
        "conversation.created"
      ],
      "active": true,
      "consecutiveFailures": 0,
      "lastFailedAt": null,
      "createdAt": "2024-06-10T14:30:00.000Z",
      "updatedAt": "2024-06-10T14:30:00.000Z"
    },
    {
      "id": "665f2b3c4d5e6f7a8b9c0d1e",
      "name": "Monitoramento de Canais",
      "url": "https://meuservidor.com.br/webhooks/canais",
      "events": [
        "channel.connected",
        "channel.disconnected"
      ],
      "active": false,
      "consecutiveFailures": 5,
      "lastFailedAt": "2024-06-10T11:55:00.000Z",
      "createdAt": "2024-06-08T09:15:00.000Z",
      "updatedAt": "2024-06-10T12:00:00.000Z"
    }
  ]
}

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou ausente"
}

429 - Limite de requisicoes excedido

{
  "error": "RATE_LIMIT_EXCEEDED",
  "message": "Limite de requisicoes excedido. Tente novamente em alguns instantes.",
  "retryAfter": 60
}

Atencao

Webhooks com consecutiveFailures igual a 5 ou mais foram desativados automaticamente. Verifique a URL de destino e reative-os via endpoint de atualizacao quando o problema for corrigido.