# Collection Flow — Kobana > Documentação completa: carteira de clientes, régua de cobrança multicanal, compliance de contato, acordos, disputas, webhooks e API. ## en Collection Flow: a multichannel collection-rule engine to recover overdue receivables with contact compliance, agreements, disputes and an audit trail. - [Collection Flow](https://docs.dunning.com.br/en/index.md): Collection Flow: a multichannel collection-rule engine to recover overdue receivables with contact compliance, agreements, disputes and an audit trail. ### search - [Search the documentation](https://docs.dunning.com.br/en/search.md) ### acordos - [Agreements](https://docs.dunning.com.br/en/acordos.md) #### documentos Generated PDF documents: the agreement term and the settlement letter, built from operation data and retrieved via the API. - [Generated documents (PDF)](https://docs.dunning.com.br/en/acordos/documentos.md): Generated PDF documents: the agreement term and the settlement letter, built from operation data and retrieved via the API. #### negociacao Negotiation and agreements: how an agreement rolls debts into installments, the agreement lifecycle and the portal's server-side validation. - [Negotiation and agreements](https://docs.dunning.com.br/en/acordos/negociacao.md): Negotiation and agreements: how an agreement rolls debts into installments, the agreement lifecycle and the portal's server-side validation. #### parcelas-e-quebra Agreement installments and break: how installments are generated, recording payments and what happens when an agreement breaks. - [Installments and default](https://docs.dunning.com.br/en/acordos/parcelas-e-quebra.md): Agreement installments and break: how installments are generated, recording payments and what happens when an agreement breaks. ### api Collection Flow API reference: full contracts for the v1 endpoints, generated from the OpenAPI spec. - [API Reference](https://docs.dunning.com.br/en/api.md): Collection Flow API reference: full contracts for the v1 endpoints, generated from the OpenAPI spec. ### carteira - [Portfolio](https://docs.dunning.com.br/en/carteira.md) #### classificacoes Classifications segment the portfolio by payment behavior: New, Good, Regular, Bad payer — or any other split that makes sense for your operation. The Classifications page in the sidebar menu lists each one with its name, priority, whether it is auto-assigned, how many people are in it, and how many rules use it. - [Classifications](https://docs.dunning.com.br/en/carteira/classificacoes.md): Classifications segment the portfolio by payment behavior: New, Good, Regular, Bad payer — or any other split that makes sense for your operation. The Classifications page in the sidebar menu lists each one with its name, priority, whether it is auto-assigned, how many people are in it, and how many rules use it. #### clientes Customers are the people (individuals or companies) in your portfolio — in the interface, the Customers page in the sidebar menu. Everything else in the system revolves around them: charges, agreements, notifications, and the debtor portal always point to a customer. - [Customers](https://docs.dunning.com.br/en/carteira/clientes.md): Customers are the people (individuals or companies) in your portfolio — in the interface, the Customers page in the sidebar menu. Everything else in the system revolves around them: charges, agreements, notifications, and the debtor portal always point to a customer. #### exportacao Dunning exports customers and charges as CSV in two ways: immediate download (synchronous), for slices of up to 10,000 rows, and background export (the Exports page), for large datasets. - [Export](https://docs.dunning.com.br/en/carteira/exportacao.md): Dunning exports customers and charges as CSV in two ways: immediate download (synchronous), for slices of up to 10,000 rows, and background export (the Exports page), for large datasets. #### importacao The Imports page uploads your portfolio via CSV file: customers first, then charges. Processing runs in the background, row by row — rows with errors do not bring down the rest of the spreadsheet. - [Spreadsheet import](https://docs.dunning.com.br/en/carteira/importacao.md): The Imports page uploads your portfolio via CSV file: customers first, then charges. Processing runs in the background, row by row — rows with errors do not bring down the rest of the spreadsheet. ### cobrancas - [Charges](https://docs.dunning.com.br/en/cobrancas.md) #### ciclo-de-vida The charge lifecycle: statuses, the state machine and day-to-day transitions, from pending to write-off and recovery. - [Lifecycle](https://docs.dunning.com.br/en/cobrancas/ciclo-de-vida.md): The charge lifecycle: statuses, the state machine and day-to-day transitions, from pending to write-off and recovery. #### encargos Charge fees: fine, late interest, monetary correction and discount, computed idempotently in cents and in the organization's time zone. - [Fees and adjustments](https://docs.dunning.com.br/en/cobrancas/encargos.md): Charge fees: fine, late interest, monetary correction and discount, computed idempotently in cents and in the organization's time zone. #### origens Charge sources: the field that records where each charge came from — manual, spreadsheet, API or integration — to filter and diagnose. - [Charge sources](https://docs.dunning.com.br/en/cobrancas/origens.md): Charge sources: the field that records where each charge came from — manual, spreadsheet, API or integration — to filter and diagnose. #### pagamento-e-baixa Payment and settlement: how a payment comes in, what happens at settlement, the I-already-paid check and the legal hold. - [Payment and settlement](https://docs.dunning.com.br/en/cobrancas/pagamento-e-baixa.md): Payment and settlement: how a payment comes in, what happens at settlement, the I-already-paid check and the legal hold. #### valores-e-vencimento A charge's amounts: original, current, paid and balance, and how the due date sets when the collection rule kicks in. - [Amounts and due date](https://docs.dunning.com.br/en/cobrancas/valores-e-vencimento.md): A charge's amounts: original, current, paid and balance, and how the due date sets when the collection rule kicks in. ### configuracoes - [Settings](https://docs.dunning.com.br/en/configuracoes.md) #### chaves-de-api API keys authenticate integrations with the API v1. They are created in Settings → Security, by administrators only. - [API keys](https://docs.dunning.com.br/en/configuracoes/chaves-de-api.md): API keys authenticate integrations with the API v1. They are created in Settings → Security, by administrators only. #### conta-e-marca The Settings screen concentrates account administration in five tabs: Company, Users, Notifications, Integrations and Security. - [Account and brand](https://docs.dunning.com.br/en/configuracoes/conta-e-marca.md): The Settings screen concentrates account administration in five tabs: Company, Users, Notifications, Integrations and Security. #### layouts-de-email The email layout is the HTML envelope wrapping every collection message sent by email: a header with your brand, a footer with your details, and in the middle the content of the step's template. The template says what the message says; the layout says how it dresses. - [Email layouts](https://docs.dunning.com.br/en/configuracoes/layouts-de-email.md): The email layout is the HTML envelope wrapping every collection message sent by email: a header with your brand, a footer with your details, and in the middle the content of the step's template. The template says what the message says; the layout says how it dresses. #### preferencias-de-notificacao Notification preferences are the type × channel switch for the messages the system sends to the debtor. They answer questions like "I want reminders by email, but not by SMS" without touching any collection rule. - [Notification preferences](https://docs.dunning.com.br/en/configuracoes/preferencias-de-notificacao.md): Notification preferences are the type × channel switch for the messages the system sends to the debtor. They answer questions like "I want reminders by email, but not by SMS" without touching any collection rule. ### desenvolvedores - [Developers](https://docs.dunning.com.br/en/desenvolvedores.md) #### comece-aqui Everything the dashboard does in the collection operation exists in the API v1: customers, charges, collection rules, agreements, disputes, tasks, imports, webhooks. This section covers the practical path; the full contracts are in the API Reference, generated from the OpenAPI spec (never hand-written). - [Start here](https://docs.dunning.com.br/en/desenvolvedores/comece-aqui.md): Everything the dashboard does in the collection operation exists in the API v1: customers, charges, collection rules, agreements, disputes, tasks, imports, webhooks. This section covers the practical path; the full contracts are in the API Reference, generated from the OpenAPI spec (never hand-written). #### erros Every API v1 error comes back in the same envelope: - [Errors and codes](https://docs.dunning.com.br/en/desenvolvedores/erros.md): Every API v1 error comes back in the same envelope: #### exemplos The essential flow of an integration, end to end, in curl - [Practical examples](https://docs.dunning.com.br/en/desenvolvedores/exemplos.md): The essential flow of an integration, end to end, in curl #### postman-e-sdks You do not need to build requests from scratch: the Postman collection and the OpenAPI spec are generated from the same source as the API Reference and always stay in sync with it. - [Postman and SDKs](https://docs.dunning.com.br/en/desenvolvedores/postman-e-sdks.md): You do not need to build requests from scratch: the Postman collection and the OpenAPI spec are generated from the same source as the API Reference and always stay in sync with it. ### disputas - [Disputes](https://docs.dunning.com.br/en/disputas.md) #### contestacoes When the debtor contests a charge — "I already paid", "I don't recognize this", "the amount is wrong" — continuing to collect is the worst possible move opening a dispute pauses the collection rule instantly and freezes every pending send, before any analysis. - [Disputes](https://docs.dunning.com.br/en/disputas/contestacoes.md): When the debtor contests a charge — "I already paid", "I don't recognize this", "the amount is wrong" — continuing to collect is the worst possible move opening a dispute pauses the collection rule instantly and freezes every pending send, before any analysis. #### resolucao Resolving a dispute means answering two questions: is the debtor right? (decision) and what to do with the charge? (effect). The dispute screen asks for both, plus a written, reasoned decision — mandatory, because it goes into the audit trail. - [Resolution](https://docs.dunning.com.br/en/disputas/resolucao.md): Resolving a dispute means answering two questions: is the debtor right? (decision) and what to do with the charge? (effect). The dispute screen asks for both, plus a written, reasoned decision — mandatory, because it goes into the audit trail. ### guia - [Guides](https://docs.dunning.com.br/en/guia.md) #### go-live-checklist Go-live checklist: the final review of base, rule, channels, compliance and integrations before charging real debtors. - [Go-live checklist](https://docs.dunning.com.br/en/guia/go-live-checklist.md): Go-live checklist: the final review of base, rule, channels, compliance and integrations before charging real debtors. #### guia-do-integrador Integrator guide: API key, first call, first customer and charge, webhooks and safe retries to connect an ERP or gateway to Dunning. - [Integrator's guide](https://docs.dunning.com.br/en/guia/guia-do-integrador.md): Integrator guide: API key, first call, first customer and charge, webhooks and safe retries to connect an ERP or gateway to Dunning. #### implantacao-conta-e-carteira Rollout, part 1: structure the account, apply your brand and load the customer base before designing the collection rule. - [Rollout: account and portfolio](https://docs.dunning.com.br/en/guia/implantacao-conta-e-carteira.md): Rollout, part 1: structure the account, apply your brand and load the customer base before designing the collection rule. #### implantacao-regua-e-canais Rollout, part 2: design the collection rule, publish it and turn on the sending channels to make the account a real operation. - [Rollout: rule and channels](https://docs.dunning.com.br/en/guia/implantacao-regua-e-canais.md): Rollout, part 2: design the collection rule, publish it and turn on the sending channels to make the account a real operation. #### o-produto-em-5-minutos The product in 5 minutes: what Dunning does, with which pieces and under what promise, to make good calls in the rollout guides. - [The product in 5 minutes](https://docs.dunning.com.br/en/guia/o-produto-em-5-minutos.md): The product in 5 minutes: what Dunning does, with which pieces and under what promise, to make good calls in the rollout guides. #### operacao-dia-a-dia The operator's routine once the rule is live: handle the exceptions the system flags and read the numbers to tune the machine. - [Day-to-day operations](https://docs.dunning.com.br/en/guia/operacao-dia-a-dia.md): The operator's routine once the rule is live: handle the exceptions the system flags and read the numbers to tune the machine. ### integracoes #### bling Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · OAuth connection - [Bling](https://docs.dunning.com.br/en/integracoes/bling.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · OAuth connection #### conta-azul Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · OAuth connection - [Conta Azul](https://docs.dunning.com.br/en/integracoes/conta-azul.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · OAuth connection #### faturamento-automatico Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · Real-time settlement via webhook - [Faturamento Automático](https://docs.dunning.com.br/en/integracoes/faturamento-automatico.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · Real-time settlement via webhook #### financeiro-inteligente Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand - [Financeiro Inteligente](https://docs.dunning.com.br/en/integracoes/financeiro-inteligente.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand #### gateway-kobana Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · Real-time settlement via webhook - [Kobana Gateway](https://docs.dunning.com.br/en/integracoes/gateway-kobana.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · Real-time settlement via webhook #### olist Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · OAuth connection - [Olist (Tiny)](https://docs.dunning.com.br/en/integracoes/olist.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · OAuth connection #### omie Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · Static-key connection - [Omie](https://docs.dunning.com.br/en/integracoes/omie.md): Native integration · Read-only (pull) · Syncs automatically every 60 min (configurable) + on demand · Static-key connection #### visao-geral Integrations connect Dunning to the systems where your charges already originate — the Kobana Gateway, the sibling Faturamento and Financeiro products, and market ERPs such as Bling, Conta Azul, Omie and Olist/Tiny. Instead of re-registering charges by hand, you connect the source once and Dunning starts pulling the charges and customers from there to collect on them with the collection rule, the portal and the agreements. - [Integrations](https://docs.dunning.com.br/en/integracoes/visao-geral.md): Integrations connect Dunning to the systems where your charges already originate — the Kobana Gateway, the sibling Faturamento and Financeiro products, and market ERPs such as Bling, Conta Azul, Omie and Olist/Tiny. Instead of re-registering charges by hand, you connect the source once and Dunning starts pulling the charges and customers from there to collect on them with the collection rule, the portal and the agreements. ### metricas - [Metrics](https://docs.dunning.com.br/en/metricas.md) #### dashboard The dashboard is Dunning's home: the portfolio snapshot on top, the operational row in the middle, and the details below. Every card is clickable and leads to the corresponding filtered screen. - [Dashboard](https://docs.dunning.com.br/en/metricas/dashboard.md): The dashboard is Dunning's home: the portfolio snapshot on top, the operational row in the middle, and the details below. Every card is clickable and leads to the corresponding filtered screen. #### recuperacao The recovery metrics answer the question that justifies the product: what did the rule do for you? The answer is built on honest attribution — the system only calls something "recovered" if it was actually in recovery, and it tells you which step and channel last touched the debtor before the money came in. - [Recovery](https://docs.dunning.com.br/en/metricas/recuperacao.md): The recovery metrics answer the question that justifies the product: what did the rule do for you? The answer is built on honest attribution — the system only calls something "recovered" if it was actually in recovery, and it tells you which step and channel last touched the debtor before the money came in. ### negativacao-e-protesto - [Credit Bureau and Protest](https://docs.dunning.com.br/en/negativacao-e-protesto.md) #### remocao-e-cancelamento Registering with the credit bureau or protesting is half the job; the other half is taking the record down at the right time. A debtor who paid and remains registered with the bureau is a legal liability — timely removal is the creditor's obligation, not a courtesy. - [Removal and cancellation](https://docs.dunning.com.br/en/negativacao-e-protesto/remocao-e-cancelamento.md): Registering with the credit bureau or protesting is half the job; the other half is taking the record down at the right time. A debtor who paid and remains registered with the bureau is a legal liability — timely removal is the creditor's obligation, not a courtesy. #### workflow Credit bureau registration (negativação — with SPC, Serasa or Boa Vista) and notary protest are not "collection rule channels" — sending a CPF to a credit bureau is not like sending an email. They are legal acts with serious consequences for the debtor and real liability for your company the rule can initiate, but nothing is registered with the bureau or the notary office without a human approving it. - [Legal workflow](https://docs.dunning.com.br/en/negativacao-e-protesto/workflow.md): Credit bureau registration (negativação — with SPC, Serasa or Boa Vista) and notary protest are not "collection rule channels" — sending a CPF to a credit bureau is not like sending an email. They are legal acts with serious consequences for the debtor and real liability for your company the rule can initiate, but nothing is registered with the bureau or the notary office without a human approving it. ### operacao - [Operations](https://docs.dunning.com.br/en/operacao.md) #### auditoria The Audit screen is the immutable trail of everything that happened in the account the record you present when a debtor, a lawyer or a judge asks "why did you do that?". - [Audit](https://docs.dunning.com.br/en/operacao/auditoria.md): The Audit screen is the immutable trail of everything that happened in the account the record you present when a debtor, a lawyer or a judge asks "why did you do that?". #### estrutura-organizacional The Structure screen organizes the account in three levels: workspaces, companies and branches. This hierarchy is what separates portfolios, scopes reports and defines on whose behalf communications go out. - [Organizational structure](https://docs.dunning.com.br/en/operacao/estrutura-organizacional.md): The Structure screen organizes the account in three levels: workspaces, companies and branches. This hierarchy is what separates portfolios, scopes reports and defines on whose behalf communications go out. #### membros-e-permissoes The Members screen answers "who accesses the account and what can each person do". Each member has one or more roles; each role is a set of permissions from the product's catalog. - [Members and permissions](https://docs.dunning.com.br/en/operacao/membros-e-permissoes.md): The Members screen answers "who accesses the account and what can each person do". Each member has one or more roles; each role is a set of permissions from the product's catalog. #### tarefas-e-equipe The Tasks screen is the operators' work queue: everything the collection rule cannot resolve on its own (or that you chose to handle manually) becomes a task with a type, priority and due date. - [Tasks and team](https://docs.dunning.com.br/en/operacao/tarefas-e-equipe.md): The Tasks screen is the operators' work queue: everything the collection rule cannot resolve on its own (or that you chose to handle manually) becomes a task with a type, priority and due date. ### portal-do-devedor - [Debtor Portal](https://docs.dunning.com.br/en/portal-do-devedor.md) #### autoatendimento The debtor portal is where customers resolve their own pending debts: view what they owe, pay by boleto or Pix, simulate an installment plan and close an agreement — without talking to anyone on your team, at any hour. - [Self-service](https://docs.dunning.com.br/en/portal-do-devedor/autoatendimento.md): The debtor portal is where customers resolve their own pending debts: view what they owe, pay by boleto or Pix, simulate an installment plan and close an agreement — without talking to anyone on your team, at any hour. #### conta-do-devedor Beyond the quick access by link, the portal offers a persistent account: the debtor creates a login with email and password and comes back whenever they want — at /conta — to track debts, agreements, history and profile over time, without depending on a new link each time. - [Debtor account](https://docs.dunning.com.br/en/portal-do-devedor/conta-do-devedor.md): Beyond the quick access by link, the portal offers a persistent account: the debtor creates a login with email and password and comes back whenever they want — at /conta — to track debts, agreements, history and profile over time, without depending on a new link each time. #### seguranca The portal exposes debt data on the open internet — in the link-based access, without even a login — so every layer of protection matters. This page documents the security model of the link-based access for you to answer audits and customer questions precisely. The persistent account (email and password) has its own protections, described on its page. - [Security](https://docs.dunning.com.br/en/portal-do-devedor/seguranca.md): The portal exposes debt data on the open internet — in the link-based access, without even a login — so every layer of protection matters. This page documents the security model of the link-based access for you to answer audits and customer questions precisely. The persistent account (email and password) has its own protections, described on its page. #### white-label The debtor should negotiate with your brand — not with a generic collection system. A charge that arrives with the creditor's identity carries more legitimacy, raises less suspicion ("is this a scam?") and converts better. - [White-label](https://docs.dunning.com.br/en/portal-do-devedor/white-label.md): The debtor should negotiate with your brand — not with a generic collection system. A charge that arrives with the creditor's identity carries more legitimacy, raises less suspicion ("is this a scam?") and converts better. ### primeiros-passos #### checklist-de-onboarding The Getting started card: the four steps, checked off from your real data, that take an empty account to a live collection rule. - [Onboarding checklist](https://docs.dunning.com.br/en/primeiros-passos/checklist-de-onboarding.md): The Getting started card: the four steps, checked off from your real data, that take an empty account to a live collection rule. #### conceitos The Dunning glossary on one page: customer, charge, collection rule, step, agreement, dispute and other terms as they appear in the interface. - [Concepts](https://docs.dunning.com.br/en/primeiros-passos/conceitos.md): The Dunning glossary on one page: customer, charge, collection rule, step, agreement, dispute and other terms as they appear in the interface. #### primeira-cobranca Step-by-step to create your first customer, register a charge and watch the collection rule take over, in five minutes. - [Your first charge](https://docs.dunning.com.br/en/primeiros-passos/primeira-cobranca.md): Step-by-step to create your first customer, register a charge and watch the collection rule take over, in five minutes. #### visao-geral Overview of Dunning: how the collection rule follows every charge from due date to payment, and what stays in the operator's hands. - [Overview](https://docs.dunning.com.br/en/primeiros-passos/visao-geral.md): Overview of Dunning: how the collection rule follows every charge from due date to payment, and what stays in the operator's hands. ### regua-de-cobranca - [Collection Rules](https://docs.dunning.com.br/en/regua-de-cobranca.md) #### campanhas-de-negociacao A negotiation campaign is a reusable discount that the debtor portal offers automatically — without an operator having to create proposal after proposal. You define the discount, the maximum number of installments and, optionally, the overdue-days range in which the campaign applies; the portal does the rest. - [Negotiation campaigns](https://docs.dunning.com.br/en/regua-de-cobranca/campanhas-de-negociacao.md): A negotiation campaign is a reusable discount that the debtor portal offers automatically — without an operator having to create proposal after proposal. You define the discount, the maximum number of installments and, optionally, the overdue-days range in which the campaign applies; the portal does the rest. #### como-funciona A collection rule is a sequence of steps anchored to the charge's due date: a reminder 3 days before, a notice on the day, a firm email 5 days after, an agreement offer at 15 days, and so on. You design the sequence once and the engine runs it for every charge, every day, without anyone having to remember anything. - [How it works](https://docs.dunning.com.br/en/regua-de-cobranca/como-funciona.md): A collection rule is a sequence of steps anchored to the charge's due date: a reminder 3 days before, a notice on the day, a firm email 5 days after, an agreement offer at 15 days, and so on. You design the sequence once and the engine runs it for every charge, every day, without anyone having to remember anything. #### compliance-de-contato This is the product's central guarantee depending on the state, it is a legal violation. - [Contact compliance](https://docs.dunning.com.br/en/regua-de-cobranca/compliance-de-contato.md): This is the product's central guarantee depending on the state, it is a legal violation. #### etapas-e-canais Each step of the collection rule answers three questions: when to fire (trigger), what to do (action) and through which channel to speak (channels). This page details the options for each. - [Steps and channels](https://docs.dunning.com.br/en/regua-de-cobranca/etapas-e-canais.md): Each step of the collection rule answers three questions: when to fire (trigger), what to do (action) and through which channel to speak (channels). This page details the options for each. #### templates-e-variaveis Templates are the messages that collection rule steps send. Each template belongs to a channel (email, SMS, WhatsApp, voice), has a category, a tone and a body with variables that the engine replaces with the charge's real data at send time. - [Templates and variables](https://docs.dunning.com.br/en/regua-de-cobranca/templates-e-variaveis.md): Templates are the messages that collection rule steps send. Each template belongs to a channel (email, SMS, WhatsApp, voice), has a category, a tone and a body with variables that the engine replaces with the charge's real data at send time. #### versoes-e-publicacao Collection rules change: you tweak a text, add a step, change an offset. What cannot change is the plan of those already mid-flow — nor your ability to prove, months later, exactly which sequence was in force when that debtor was contacted. That is what versions are for. - [Versions and publishing](https://docs.dunning.com.br/en/regua-de-cobranca/versoes-e-publicacao.md): Collection rules change: you tweak a text, add a step, change an offset. What cannot change is the plan of those already mid-flow — nor your ability to prove, months later, exactly which sequence was in force when that debtor was contacted. That is what versions are for. ### webhooks #### entregas-e-retry No delivery is "fire and forget". Each event × endpoint becomes a delivery record with status, attempts and the full capture of request and response — which turns "the webhook never arrived" from a mystery into a lookup. - [Deliveries and retry](https://docs.dunning.com.br/en/webhooks/entregas-e-retry.md): No delivery is "fire and forget". Each event × endpoint becomes a delivery record with status, attempts and the full capture of request and response — which turns "the webhook never arrived" from a mystery into a lookup. #### eventos The full catalog of emitted events. Names follow the . pattern; the payload's data field carries the resource serialized in the v1 API format or a lean reference object (documented per event). An endpoint with an empty event list receives all of them, including future events. - [Events](https://docs.dunning.com.br/en/webhooks/eventos.md): The full catalog of emitted events. Names follow the . pattern; the payload's data field carries the resource serialized in the v1 API format or a lean reference object (documented per event). An endpoint with an empty event list receives all of them, including future events. - [Agreement events (agreement.*)](https://docs.dunning.com.br/en/webhooks/eventos/agreement.md): Facts from the lifecycle of negotiation agreements. In entity events, data is the agreement with the summarized customer (person) and, once generated, the installments (installments). - [Charge events (charge.*)](https://docs.dunning.com.br/en/webhooks/eventos/charge.md): Facts from the charge lifecycle. In entity events, data is the charge serialized in the v1 API format, with the full person and collectionRule embedded. In fact events (paid, overdue), data is a lean reference object. - [Classification events (classification.*)](https://docs.dunning.com.br/en/webhooks/eventos/classification.md): Customer categories (e.g. good payer, recurring late payer) that drive the collection rules. In entity events, data is the full classification with usage counters (_count). - [Collection rule events (collection_rule.*)](https://docs.dunning.com.br/en/webhooks/eventos/collection-rule.md): Collection rule configuration. In entity events, data is the rule with the linked classification and the steps ordered by position. - [Dispute events (dispute.*)](https://docs.dunning.com.br/en/webhooks/eventos/dispute.md): Contestations opened by the debtor (or logged by the operator). Opening a dispute pauses the collection rule of the charge immediately. In all events, data is the full dispute. - [Interaction events (interaction.*)](https://docs.dunning.com.br/en/webhooks/eventos/interaction.md): Records from the customer contact timeline (calls, emails, notes). data is the full interaction with the summarized person, user (who logged it) and charge. - [Negativation events (negativation.*)](https://docs.dunning.com.br/en/webhooks/eventos/negativation.md): Registration of the debtor with the credit bureaus. Every negativation triggered by the collection rule goes through mandatory human review before taking effect. data is always a lean reference object. - [Notification events (notification.*)](https://docs.dunning.com.br/en/webhooks/eventos/notification.md): Lifecycle of the messages the collection rule sends to the debtor (email, SMS, WhatsApp...). data is always a lean reference object — the full resource lives at GET /api/v1/notifications/. - [Customer events (person.*)](https://docs.dunning.com.br/en/webhooks/eventos/person.md): Facts from the customer (debtor) registry. In entity events, data is the customer serialized in the customers v1 API format, with the summarized classification embedded. - [Protest events (protest.*)](https://docs.dunning.com.br/en/webhooks/eventos/protest.md): Protest of receivables at a notary office (cartório). As with negativation, every protest triggered by the collection rule goes through mandatory human review before being sent. data is always a lean reference object. - [Task events (task.*)](https://docs.dunning.com.br/en/webhooks/eventos/task.md): Manual tasks of the operation (created by operators or by the collection rule — e.g. negativation/protest review). In entity events, data is the task with the summarized person, assignedTo and charge. - [Template events (template.*)](https://docs.dunning.com.br/en/webhooks/eventos/template.md): Message templates used by the collection rule steps. In entity events, data is the full template (no relations). - [Test event (webhook.test)](https://docs.dunning.com.br/en/webhooks/eventos/webhook-test.md): Fired on demand via POST /api/v1/webhook-endpoints//test — it is not subscribable and does not appear in the subscription catalog. The delivery travels the real pipeline (queue, HMAC signature, request/response capture, retry) and is sent only to the target endpoint, regardless of the subscribed event list. #### seguranca Two layers protect the communication: the HMAC signature (proves the payload came from Dunning and was not tampered with) and request authentication (credentials Dunning presents to your endpoint). The first is always included; the second is optional. - [Security](https://docs.dunning.com.br/en/webhooks/seguranca.md): Two layers protect the communication: the HMAC signature (proves the payload came from Dunning and was not tampered with) and request authentication (credentials Dunning presents to your endpoint). The first is always included; the second is optional. #### visao-geral Webhooks overview: receive Dunning's business events as JSON POSTs, with HMAC signature, persisted delivery and automatic retry. - [Overview](https://docs.dunning.com.br/en/webhooks/visao-geral.md): Webhooks overview: receive Dunning's business events as JSON POSTs, with HMAC signature, persisted delivery and automatic retry.