Manual do Dev
InstitucionalBlogService DeskStatus Page

Consultas

beta scopes: webhook.read

Suggest Edits

Por meio de nossas APIs, é possível realizar a consulta de todas as configurações dos webhooks registradas ou consultar a configuração de algum webhook específico.

Consulta de todas as configurações dos webhooks

Etapas

Endpoint

O endpoint a seguir retornará todas as configurações que você registrou.

--location --request GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/' \  
--header 'Content-Type: application/json' \  
--header 'Authorization: {Bearer token}' \

Para customizar sua pesquisa, insira no path os seguintes parâmetros:

  • status: preencha com Enabled, para verificar configurações habilitadas, ou Disabled, para configurações desabilitadas;
  • page: informe o número da página a ser exibida. O valor mínimo é 1;
  • pageSize: insira o número de resultados por página. O valor máximo é 100. 
--location --request GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations?status=Enabled&page=2&pageSize=50' \  
--header 'Content-Type: application/json' \  
--header 'Authorization: {Bearer token}' \

Retorno

A consulta retornará os seguintes campos:

  • id: valor em UUID v4 que identifica o webhook criado. Esse valor será requerido para realizar outras ações relativas às configurações do webhook;
  • eventName: nome do evento;
  • context: nome que indica o contexto em que o evento ocorreu;
  • uri: URI de recebimento dos eventos;
  • publicKey: chave que é enviada nos cabeçalhos dos eventos de webhook;
  • createdAt: data e hora de criação da configuração;
  • status: indica se o evento está habilitado (enabled) ou desabilitado (disabled).
Exemplo de retorno 
{
   "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
   }
}

👍

Dica

O campo total indicará a 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.

Consulta de configuração de webhook específico

Etapas

Endpoint

Para consumo do endpoint a seguir, no path da requisição, preencha o campo id com o valor do ID do webhook. Esse ID é um identificador retornado no registro de uma configuração de webhook, que pode ser obtido na consulta de todas as configurações de webhooks descrita acima. 

--location --request GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/:{id}' \  
--header 'Content-Type: application/json' \  
--header 'Authorization: Bearer [token]' \

Retorno

{
   "data": {
      "id": "e77748a7-dcd2-4f22-9242-096420dc6fa3",
      "name": "TED_CASH_IN_WAS_CLEARED",
      "context": "Ted",
      "eventName": "TED_CASH_IN_WAS_CLEARED",
      "uri": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
      "publicKey": "MGE4NDIwM2ItNmU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj"
   },
   "links": [
      {
         "url": "https://api.sandbox.bankly.com.br/webhooks/e77748a7-dcd2-4f22-9242-096420dc6fa3",
         "rel": "update_webhook",
         "method": "PATCH"
      },
      {
         "url": "https://api.sandbox.bankly.com.br/webhooks/e77748a7-dcd2-4f22-9242-096420dc6fa3",
         "rel": "delete_webhook",
         "method": "DELETE"
      }
   ]
}

Updated 11 months ago