Webhooks

Listar webhooks

Retorna todos os endpoints de webhook cadastrados na sua conta, com contadores de entrega e status. Use para encontrar o id exigido pelos endpoints de entregas, reenvio e reativação.

GEThttps://graph.sendcorex.com/v3.0/webhooks

Parâmetros

Este endpoint não recebe parâmetros.

Início rápido

import axios from 'axios';

const response = await axios.get('https://graph.sendcorex.com/v3.0/webhooks', {
  headers: { Authorization: process.env.SENDCOREX_API_KEY },
});

console.log(response.data);

Resposta

{
  "success": true,
  "webhooks": [
    {
      "id": "wh_123",
      "webhookUrl": "https://example.com/hooks/sendcorex",
      "isActive": true,
      "events": null,
      "delivered": 1204,
      "pending": 2,
      "failed": 6,
      "createdAt": "2026-06-01T09:12:00.000Z"
    }
  ],
  "responseTime": "12ms"
}

Campos da resposta

  • id

    ID do endpoint de webhook. Use nos outros endpoints de webhook.

  • webhookUrl

    A URL cadastrada para receber os eventos.

  • isActive

    Se o endpoint está ativo no momento.

  • events

    Eventos assinados. null significa todos os eventos.

  • delivered / pending / failed

    Contadores de entrega deste endpoint.

  • createdAt

    Data de criação em ISO 8601.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401INVALID_API_KEY

    A API key é inválida ou foi revogada.