InstitucionalBlogService DeskStatus Page

Consulta de configuração de webhook específico

stable

Suggest Edits

Este endpoint permite realizar a consulta da configuração de um webhook específico.

Requisição

Requisição HTTP

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

curl --request GET \
			--url 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/e77748a7-dcd2-4f22-9242-096420dc6fa3' \  
			--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:

ScopeDescrição
webhook.readConcede acesso para consultar configurações de webhooks, pesquisar mensagens enviadas e realizar o reprocessamento de mensagens.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

NomeTipoDescrição
idpathObrigatório. id do webhook, que pode ser obtido na consulta de todas as configurações de webhooks.

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:

NomeTipoDescrição
dataarray of objectsLista que contém objetos com os dados das configurações dos webhooks registrados.
data.idstringValor em UUID v4 que identifica o webhook criado. Esse valor será requerido para realizar outras ações relativas às configurações do webhook.
data.namestringNome que o assinante deu para identificar o evento.
data.contextstringNome que indica o contexto em que o evento ocorreu
data.eventNamestringNome do evento.
data.uristringURI de recebimento dos eventos.
data.publicKeystringChave aleatória gerada pelo parceiro e que é enviada nos cabeçalhos dos eventos de webhook.
linksarray of objectsLista de links de próximos estados válidos da entidade/recurso.
links.urlstringURLs que podem ser utilizadas em um próximo estado da entidade.
links.relstringDescrição de como a URL se relaciona com o recurso atual.
links.methodstringTipo de verbo que deve ser utilizado para acessar a URL.
{
   "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-mtls.sandbox.bankly.com.br/webhooks/e77748a7-dcd2-4f22-9242-096420dc6fa3",
         "rel": "update_webhook",
         "method": "PATCH"
      },
      {
         "url": "https://api-mtls.sandbox.bankly.com.br/webhooks/e77748a7-dcd2-4f22-9242-096420dc6fa3",
         "rel": "delete_webhook",
         "method": "DELETE"
      }
   ]
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

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.

Updated 6 months ago