Consulta de todas as configurações de webhooks

Este endpoint permite realizar a consulta de todas as configurações dos webhooks registradas.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/WebhookInternal/webhooks

--request GET 'https://sandbox.hiperbanco.com.br/WebhookInternal/webhooks' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição
`status`	`query`	Status das configurações. Informe `Enabled`, para verificar configurações habilitadas, ou `Disabled`, para configurações desabilitadas.
`page`	`query`	Número da página a ser exibida. O valor mínimo é 1.
`pageSize`	`query`	Número de resultados por página. O valor máximo é 100.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Número máximo de caracteres
`data`	`array of objects`	Lista de objetos contendo informações sobre as configurações dos webhooks registrados.	—
`data.id`	`string`	Valor em UUID v4 que identifica o webhook criado. Esse valor será requerido para realizar outras ações relativas às configurações do webhook.	—
`data.name`	`string`	Nome da configuração.	50
`data.context`	`string`	Nome que indica o contexto em que o evento ocorreu.	50
`data.eventName`	`string`	Nome do evento.	150
`data.uri`	`string`	URI de recebimento dos eventos.	500
`data.publicKey`	`string`	Chave aleatória gerada pelo parceiro e que é enviada nos cabeçalhos dos eventos de webhook.	60
`data.createdAt`	`string`	Data e hora de criação da configuração, no formato ISO 8601 - UTC.	—
`data.updatedAt`	`string`	Data e hora de atualização da configuração, no formato ISO 8601 - UTC.	—
`data.status`	`string`	Indica se o evento está habilitado (`Enabled`) ou desabilitado (`Disabled`).	—
`meta`	`dictionary<string, object>`	Dicionário de metadados que trará dados adicionais da requisição.	—
`meta.page`	`number`	Número da página da consulta.	—
`meta.pageSize`	`number`	Quantidade de itens por página.	—
`meta.total`	`number`	Quantidade de mensagens retornadas na pesquisa. Desse modo, é possível saber se é preciso realizar uma nova pesquisa com novo número de página ou outro `pageSize`.	—

{
   "data": [
      {
         "id": "15aab67f-18fe-45d3-8b7b-e999de104b04",
         "name": "WEBHOOK_PIX",
         "eventName": "PIX_CASH_IN_WAS_CLEARED",
         "context": "Pix",
         "uri": "http://webhook.site/42e35ca3-2e34-465f-bc81-08b0b3d703d0",
         "publicKey": "MGE4NDIwM2ItNmU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJk",
         "createdAt": "2021-11-22T14:11:30.18",
         "status": "Enabled"
      },
      {
         "id": "e77748a7-dcd2-4f22-9242-096420dc6fa3",
         "name": "WEBHOOK_TED",
         "eventName": "TED_CASH_IN_WAS_CLEARED",
         "context": "Ted",
         "uri": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "publicKey": "MGE4NDIwM2ItNmU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj",
         "createdAt": "2021-11-22T18:52:55.71",
         "updatedAt": "2021-11-22T18:58:23.273",
         "status": "Disabled"
      }
   ],
   "meta": {
      "page": 1,
      "pageSize": 10,
      "total": 13
   }
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.