Docs
get https://api.pix.iugu.com/api/v2/webhook

Consultar webhooks cadastrados.

Endpoint para consultar Webhooks cadastrados

Sem ações implementadas definidas

Request

Query params

inicio

Type: string

fim

Type: string

paginacao.paginaAtual

Type: integer

paginacao.itensPorPagina

Type: integer

Headers

workspace_id

Required

Type: string

Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200

lista dos locations cadastrados de acordo com o critério de busca.

parametros
Object

Parâmetros utilizados para a realização de uma consulta de Webhooks.

inicio
String

Data inicial utilizada na consulta. Respeita RFC 3339.

Ex: 2020-01-01T00:00:00Z

fim
String

Data de fim utilizada na consulta. Respeita RFC 3339.

Ex: 2020-12-01T17:00:00Z

paginacao
Object

paginaAtual
Integer >= 0

Número da página recuperada.

itensPorPagina
Integer >= 1

Quantidade de registros retornado na página.

Ex: 100

quantidadeDePaginas
Integer >= 1

Quantidade de páginas disponí­veis para consulta.

Ex: 5

quantidadeTotalDeItens
Integer >= 0

Quantidade total de itens disponí­veis de acordo com os paâmetros informados.

Ex: 503

webhooks
Array

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "parametros": {
    "inicio": "2020-01-01T00:00:00Z",
    "fim": "2020-12-01T17:00:00Z",
    "paginacao": {
      "paginaAtual": "<PAGINAATUAL>",
      "itensPorPagina": 100,
      "quantidadeDePaginas": 5,
      "quantidadeTotalDeItens": 503
    }
  },
  "webhooks": [
    "<WEBHOOKS>"
  ]
}

403

Requisição de participante autenticado que viola alguma regra de autorização.

type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado

title
String

Descrição resumida do problema.

Ex: Not found

status
Integer

Código HTTP do status retornado.

Ex: 404

detail
String

Descrição completa do problema.

correlationId
String

Identificador de correlação do problema para fins de suporte

violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00

propriedade
String

Nome da propriedade

Ex: cob.chave

valor
String

Valor da propriedade

Ex: 061996671234

503

Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.

type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado

title
String

Descrição resumida do problema.

Ex: Not found

status
Integer

Código HTTP do status retornado.

Ex: 404

detail
String

Descrição completa do problema.

correlationId
String

Identificador de correlação do problema para fins de suporte

violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00

propriedade
String

Nome da propriedade

Ex: cob.chave

valor
String

Valor da propriedade

Ex: 061996671234