Listar entregas de webhook

GET

/vintem/v1/webhooks/entregas

curl --request GET \
  --url 'http://localhost:8080/vintem/v1/webhooks/entregas?status=pendente&limite=100' \
  --header 'Authorization: Bearer <token>'

Exige o escopo webhook:admin. Lista as entregas de eventos aos destinos, pela ordem da próxima tentativa. Chave restrita a uma conta só vê as entregas dela.

Authorizations

• apiKey

Parameters

Query Parameters

status

string

default: dlq

Allowed values: pendente entregue dlq

limite

integer

default: 100 >= 1 <= 500

Responses

200

Entregas encontradas.

Media typeapplication/json

object

entregas

required

Array<object>

Uma entrega de evento a um destino (Standard Webhooks, com outbox e DLQ).

object

eventoId

required

string

destinoId

required

string

contaId

required

string

tipo

required

string

status

required

string

Allowed values: pendente entregue dlq

tentativas

required

Tentativas feitas desde a criação ou o último reenvio.

integer

ultimoHttp

Status HTTP da última tentativa; ausente se não houve resposta.

integer

ultimoErro

string

criadaEm

required

string format: date-time

proximaEm

required

string format: date-time

atualizadaEm

required

string format: date-time

Example

{
  "entregas": [
    {
      "tipo": "cobranca.concluida",
      "status": "pendente"
    }
  ]
}

default

Qualquer outro erro, sempre como Problema. Os mais comuns: 502 quando o banco recusa ou falha (PSPIndisponivel) e 500 para erro interno.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

correlationId

string

violacoes

Array<object>

object

razao

string

propriedade

string

valor

string

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}