Webhooks - Eventos e Configurações
Webhooks - Sacado
Para que os eventos ocorridos com o seu perfil (ex.: títulos que foram antecipados) sejam informados à você, existem Webhooks que são chamados no momento em que tais eventos ocorrem.
Quando um evento acontece, o sistema envia uma requisição HTTP POST para todos os webhooks configurados contendo as informações relativas ao evento e links HATEOAS que auxiliam na navegação da sua API pelos outros recursos que se relacionam com o tipo de evento.
Nossos webhooks contam com um mecanismo de retry, portanto retentamos durante duas horas ou até recebermos o HTTP status 200 OK.
Sua API deve respeitar o princípio de idempotência, pois em casos raros o webhook poderá ser entregue mais de uma vez.
Configuração de Webhook
Para receber estas requisições, você deve configurar um webhook, para isso acesse a plataforma e vá em Configurações -> Webhooks -> Configurar
Eventos
Evento | Tipo (Cadastro) | Tipo (Busca) | Descrição |
---|---|---|---|
Título Negociado | CUSTODY_RESPONSE_GROUPED | CustodyResponseEvent | Dispara uma requisição para /payables-response com dados dos títulos que foram comprados ou recusados pelo investidor. |
Título Deletado | PAYABLE_DELETED | PayableDeletedEvent | Dispara uma requisição para /payables com dados do título que foi deletado. No body da requisição existe um campo indicando a ação. eventType: PayableDeletedEvent |
Título Duplicado | PAYABLE_DUPLICATED | PayableDuplicatedEvent | Dispara uma requisição para /payables com dados do título que foi enviado para criação, porém já existe na plataforma. No body da requisição existe um campo indicando a ação. eventType: PayableDuplicatedEvent |
Boleto Gerado | BILL_GENERATED | BillGeneratedEvent | Dispara uma requisição para /bill com os dados do boleto (Linha Digitável e URL), esse evento não indica que o boleto já foi aceito. |
Boleto Registrado | BILL_REGISTERED | BillRegisteredEvent | Dispara uma requisição para /bill com os dados do boleto (Linha Digitável e URL), quando é registrado no DDA. |
Updated about 1 year ago