Alteração e exclusão
beta scopes: webhook.write webhook.delete
Veja a seguir como alterar ou excluir a configuração de um webhook.
Alteração da configuração
O endpoint de alteração de configuração de webhooks permite alterar a chave pública, a chave privada e/ou a URI do endpoint do webhook do parceiro.
Etapas
Endpoint
Para o consumo desse endpoint, no path da requisição, preencha o campo id com o valor do ID do webhook.
No body, informe os seguintes campos com a alteração desejada:
privateKey: chave em base64 que somente o Bankly e o dono da chave conhecem. Essa chave não é enviada em nenhum evento. Exemplo: V2ViaG9vayBBY2Vzc29CYW5rbHk=;publicKey: chave enviada nos cabeçalhos dos eventos de webhook;uri: URI de sua API para o recebimento dos eventos.
--location --request PATCH 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/:{id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [token]' \
--data-raw '{
"privateKey": "NTRlNzM0NGMtNTdmMC00MjQ4LThiZTEtM2ZhMDg4NzcwZTA5",
"publicKey": "MGE4NDIwM2ItNmU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj",
"uri": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6"
}
Importante
Mesmo que só uma das informações seja alterada, os três campos do body devem ser enviados com seus respectivos valores.
Retorno
O status code 200 indicará que a alteração foi realizada com sucesso.
Exemplo de retorno
{
"data": {
"id": "b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
"name": "TED_CASH_IN_TESTE",
"context": "Ted",
"eventName": "TED_CASH_IN_WAS_CLEARED",
"uri": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d8",
"publicKey": "MGE4NDIwM2ItNmU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj"
},
"links": [
{
"url": "https://api-mtls.sandbox.bankly.com.br/webhooks/b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
"rel": "get_webhook",
"method": "GET"
},
{
"url": "https://api-mtls.sandbox.bankly.com.br/webhooks/b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
"rel": "update_webhook",
"method": "PATCH"
},
{
"url": "https://api-mtls.sandbox.bankly.com.br/webhooks/b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
"rel": "delete_webhook",
"method": "DELETE"
}
]
}
Erros
| Status code | Código | Descrição |
|---|---|---|
| 404 | NOT_FOUND | Configuração não encontrada. |
| 409 | WEBHOOK_CONFIGURATION_ALREADY_EXISTS | Essa configuração já existe. |
Exclusão de configuração
Etapas
Endpoint
Para excluir uma configuração de webhook, informe seu id no path da requisição:
--location --request DELETE 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/:{id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [token]' \
Retorno
O status code 204 indicará que a configuração do webhook foi excluída com sucesso.
Erro
| Status code | Código | Descrição |
|---|---|---|
| 404 | NOT_FOUND | Configuração não encontrada. |
Updated 12 months ago