v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Configurar webhooks

Essa API permite realizar a configuração da(s) URL(s) que receberá(ão) as atualizações de status do cadastro, exclusão e de boletos. Veja nosso artigo e saiba como realizar a implementação dessa API.

Para atualizar a URL cadastrada, basta realizar uma nova requisição, pois ela irá sobrescrever a configuração anterior.

post/dda-servicewebhook-webservice/v1/webhook/register

Request body

typeEventWebhookstring required

Tipo de evento da notificação. Pode ser definido como: Subscription, Deletion ou Invoice (um para cada requisição)

urlstring required

O endereço do seu serviço na web.

Response

200

statusinteger

Example response

{
  "status": 201,
  "body": {
    "typeEventWebhook": "Invoice",
    "url": "https://webhook.site/d24aa98f-1837-4698-8825-688f94390cfe",
    "basicAuthentication": {
      "identification": "João",
      "password": "Um@Pro7ec@o"
    }
  }
}