Webhooks

Listar entregas

Retorna as tentativas de entrega de um endpoint de webhook, com paginação. Filtre por status para separar as entregas bem-sucedidas das que falharam ou estão pendentes.

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

Parâmetros

  • idstringobrigatório

    Parâmetro de caminho. ID do endpoint de webhook.

    ex.: "wh_123"

  • statusstringopcional

    Parâmetro de query. delivered ou failed (failed inclui as pendentes). Omita para ver todas.

    ex.: "failed"

  • pagenumberopcional

    Parâmetro de query. Número da página. Padrão 1.

    ex.: 1

  • limitnumberopcional

    Parâmetro de query. Resultados por página. Padrão 20, máximo 50.

    ex.: 20

Início rápido

import axios from 'axios';

const response = await axios.get('https://graph.sendcorex.com/v3.0/webhooks/wh_123/deliveries?status=failed&page=1&limit=20', {
  headers: { Authorization: process.env.SENDCOREX_API_KEY },
});

console.log(response.data);

Resposta

{
  "success": true,
  "deliveries": [
    {
      "id": "del_9f3a",
      "event": "bounced",
      "status": "failed",
      "httpStatus": 500,
      "responseBody": "Internal Server Error",
      "attemptNumber": 3,
      "nextRetryAt": null,
      "createdAt": "2026-08-08T14:22:00.000Z"
    }
  ],
  "total": 47,
  "page": 1,
  "limit": 20,
  "responseTime": "38ms"
}

Campos da resposta

  • deliveries[].id

    ID da entrega. Passe para Reenviar entrega.

  • deliveries[].event

    O evento que estava sendo entregue, por exemplo bounced.

  • deliveries[].status

    Status da entrega, por exemplo failed.

  • deliveries[].httpStatus

    Status HTTP com que o seu servidor respondeu.

  • deliveries[].responseBody

    Corpo com que o seu servidor respondeu.

  • deliveries[].attemptNumber

    Quantas tentativas foram feitas.

  • deliveries[].nextRetryAt

    Quando a próxima tentativa está agendada, ou null.

  • deliveries[].createdAt

    Data e hora em ISO 8601.

  • total / page / limit

    Informações de paginação.

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.