Webhook Event Guide - Dodo Payments Documentation

Dodo Payments tillhandahåller realtids-webhook-notifikationer för att hålla dig informerad om kritiska händelser relaterade till transaktioner, prenumerationer, återbetalningar, tvister och hantering av licensnycklar. Nedan finns en detaljerad guide till dessa händelser, kategoriserade för tydlighet, tillsammans med implementeringstips och överväganden.

Betalningshändelser

Event Name	Event Type	Description
Payment Succeeded	`payment.succeeded`	Utlöses när en betalning har behandlats framgångsrikt.
Payment Failed	`payment.failed`	Uppstår när ett betalningsförsök misslyckas på grund av fel, avvisade kort eller andra problem.
Payment Processing	`payment.processing`	Indikerar att en betalning för närvarande behandlas.
Payment Cancelled	`payment.cancelled`	Utlöses när en betalning avbryts innan den slutförs.

Återbetalningshändelser

Event Name	Event Type	Description
Refund Succeeded	`refund.succeeded`	Utlöses när en återbetalning har genomförts framgångsrikt.
Refund Failed	`refund.failed`	Uppstår när ett återbetalningsförsök misslyckas på grund av bearbetningsfel eller andra problem.

Tvist-händelser

Event Name	Event Type	Description
Dispute Opened	`dispute.opened`	Utlöses när en kund initierar en tvist.
Dispute Expired	`dispute.expired`	Indikerar att en tvist löpt ut utan att ha nått någon lösning.
Dispute Accepted	`dispute.accepted`	Utlöses när en handlar accepterar tvisten.
Dispute Cancelled	`dispute.cancelled`	Uppstår när en tvist avbryts av kunden eller systemet.
Dispute Challenged	`dispute.challenged`	Utlöses när en handlar bestrider en tvist.
Dispute Won	`dispute.won`	Indikerar att handlaren framgångsrikt vunnit en tvist.
Dispute Lost	`dispute.lost`	Uppstår när handlaren förlorar en tvist.

Prenumerationshändelser

Event Name	Event Type	Description
Subscription Active	`subscription.active`	Indikerar att en prenumeration nu är aktiv och att återkommande avgifter är planerade.
Subscription Updated	`subscription.updated`	Utlöses när något fält i en prenumeration uppdateras (realtidssynk utan polling).
Subscription On Hold	`subscription.on_hold`	Utlöses när en prenumeration tillfälligt läggs på paus på grund av misslyckad förnyelse.
Subscription Renewed	`subscription.renewed`	Uppstår när en prenumeration förnyas framgångsrikt.
Subscription Plan Changed	`subscription.plan_changed`	Utlöses när en prenumeration uppgraderas, nedgraderas eller ändras med andra tillägg.
Subscription Cancelled	`subscription.cancelled`	Utlöses när en prenumeration avbryts av handlaren eller kunden.
Subscription Failed	`subscription.failed`	Indikerar en misslyckad prenumeration. Det innebär att vi inte kunde skapa ett mandat.
Subscription Expired	`subscription.expired`	Utlöses när en prenumeration når slutet av sin period och upphör.

Licensnyckelhändelser

Event Name	Event Type	Description
License Key Created	`license_key.created`	Utlöses när en ny licensnyckel skapas för en produkt.

Rättighetsbidrag Händelser

Händelsenamn	Händelsetyp	Beskrivning
Bidrag Skapat	`entitlement_grant.created`	Ett nytt rättighetsbidrag skapas för en kund. Licensnyckel-bidrag anländer `delivered`; OAuth-baserade bidrag (Discord, GitHub, Notion) anländer `pending`.
Bidrag Levererat	`entitlement_grant.delivered`	Bidragsfullgörande slutförs — licensnyckel utfärdad, fillänkar lösta eller plattformsåtkomst beviljad.
Bidrag Misslyckades	`entitlement_grant.failed`	Bidragsfullgörande misslyckades; inspektera `error_code` och `error_message`.
Bidrag Återtogs	`entitlement_grant.revoked`	Åtkomst dras tillbaka; inspektera `revocation_reason` (prenumerationstillstånd, återbetalning, planbyte eller manuell).

För detaljerade nyttolastscheman, exempel på händelser och fullständig revocation_reason referens, se Rättighetswebhooks.

Kredithändelser

Händelsenamn	Händelsetyp	Beskrivning
Kredit Tillagd	`credit.added`	Utlöses när krediter beviljas till en kund (prenumeration, engångs, tillägg eller API).
Kredit Avdragen	`credit.deducted`	Inträffar när krediter förbrukas genom användning eller manuell debitering.
Kredit Utgången	`credit.expired`	Utlöses när oanvända krediter löper ut efter den konfigurerade utgångsperioden.
Kredit Överförd	`credit.rolled_over`	Inträffar när oanvända krediter förs över till ett nytt bidrag vid cykelns slut.
Överföring Förverkad	`credit.rollover_forfeited`	Utlöses när krediter förverkas eftersom max antal överföringar har nåtts.
Överanvändning Debiterad	`credit.overage_charged`	Inträffar när överanvändningsavgifter tillämpas för användning bortom nollsaldo.
Manuell Justering	`credit.manual_adjustment`	Utlöses när en manuell kredit- eller debetjustering görs.
Låg Balans	`credit.balance_low`	Utlöses när kreditbalansen faller under den konfigurerade gränsen.

Återhämtningshändelser

Händelsenamn	Händelsetyp	Beskrivning
Övergivet Utcheckning Upptäckt	`abandoned_checkout.detected`	Utlöses när en ofullständig eller misslyckad utcheckning upptäcks efter 60 minuter.
Övergivet Utcheckning Återhämtat	`abandoned_checkout.recovered`	Inträffar när en kund slutför betalning genom en återhämtningslänk.

För detaljerade nyttolastscheman, fältbeskrivningar och exempel på hanterare, se Återhämtningswebhooks.

Inkassohändelser

Händelsenamn	Händelsetyp	Beskrivning
Inkasso Startad	`dunning.started`	Utlöses när ett inkassoförsök börjar för en prenumeration som pausades eller avbröts.
Inkasso Återhämtat	`dunning.recovered`	Inträffar när en kund uppdaterar sin betalningsmetod och den resulterande debiteringen lyckas.

För detaljerade nyttolastscheman, fältbeskrivningar och exempel på hanterare, se Återhämtningswebhooks. Dessa webhook-händelser är utformade för att ge handlare kritiska uppdateringar för att effektivt hantera sina verksamheter. Implementera robusta hanterare för varje relevant händelse i din webhook-integration för att säkerställa smidig och pålitlig funktionalitet.

​Betalningshändelser

​Återbetalningshändelser

​Tvist-händelser

​Prenumerationshändelser

​Licensnyckelhändelser

​Rättighetsbidrag Händelser

​Kredithändelser

​Återhämtningshändelser

​Inkassohändelser