Consulta de todas as configurações de webhooks

Altera a publicKey, privateKey e/ou uri de um webhook já registrado.

🚧
Importante
Apesar de ser um PATCH, os três campos (privateKey, publicKey, uri) precisam ser enviados mesmo que você queira alterar só um. Comportamento atípico para PATCH (que normalmente aceita atualização parcial).

Requisição (Request)

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/'

--request GET \
--uri 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations?status=Enabled&page=2&pageSize=50' \  
--header 'Content-Type: application/json' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: {Bearer token}' \

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`webhook.read`	Concede acesso para consultar configurações de webhooks, pesquisar mensagens enviadas e realizar o reprocessamento de mensagens.

Cabeçalhos (Headers)

Nome	Obrigatório	Descrição
`api-version`	Sim	Versão da API. Atualmente, `1.0`.
`Authorization`	Sim	Token Bearer.

Parâmetros da rota (Path)

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	UUID v4 do webhook. Obtenha em Listar configurações.

Corpo da requisição (Body)

Campo	Tipo	Obrigatório	Descrição
`privateKey`	string	Sim	Chave privada do parceiro em base64. Conhecida apenas pelo parceiro e pelo Bankly. Até 2000 caracteres (sob revisão — bem maior que `publicKey`).
`publicKey`	string	Sim	Chave pública gerada pelo parceiro, enviada nos headers dos eventos. Até 60 caracteres.
`uri`	string	Sim	URI HTTPS do endpoint do parceiro. Até 500 caracteres, formato HTTPS.

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`).	—
`links`	`array of objects`	Lista de objetos contendo informações sobre os links de próximos estados válidos da entidade/recurso.	—
`links.url`	`string`	URLs que podem ser utilizadas em um próximo estado da entidade.	—
`links.rel`	`string`	Descrição de como a URL se relaciona com o recurso atual.	—
`links.method`	`string`	Tipo de verbo que deve ser utilizado para acessar a URL.	—
`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_DELIVERY",
         "eventName": "PIX_CASH_IN_WAS_CLEARED",
         "context": "Pix",
         "uri": "http://webhook.site/42e35ca3-2e34-465f-bc81-08b0b3d703d0",
         "publicKey": "WEBHOOK_PIX_DELIVERY",
         "createdAt": "2021-11-22T14:11:30.18",
         "status": "Enabled"
      },
      {
         "id": "e77748a7-dcd2-4f22-9242-096420dc6fa3",
         "name": "TED_CASH_IN_WAS_CLEARED",
         "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"
      }
   ],
   "links": [
      {
         "url": "https://api-mtls.sandbox.bankly.com.br/webhooks?page=2&pageSize=10",
         "rel": "search_webhook",
         "method": "GET"
      }
   ],
   "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.

Importante

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Corpo da requisição (Body)

Resposta (Response)

Erros

Eventos

Artigos relacionados