API Documentation & SDKs
Subscriptions
Discounts
Licenses
Customers
Products
Payouts
Miscellaneous
Outgoing Webhooks
Send a POST request to your webhook URL to receive notifications about events that occur in your account.
curl --request POST \
--url https://test.dodopayments.com/your-webhook-url \
--header 'Content-Type: application/json' \
--header 'webhook-id: <webhook-id>' \
--header 'webhook-signature: <webhook-signature>' \
--header 'webhook-timestamp: <webhook-timestamp>' \
--data '{
"business_id": "<string>",
"data": {
"business_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "AED",
"customer": {
"customer_id": "<string>",
"email": "<string>",
"name": "<string>"
},
"discount_id": "<string>",
"disputes": [
{
"amount": "<string>",
"business_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"dispute_id": "<string>",
"dispute_stage": "pre_dispute",
"dispute_status": "dispute_opened",
"payment_id": "<string>"
}
],
"error_message": "<string>",
"metadata": {},
"payment_id": "<string>",
"payment_link": "<string>",
"payment_method": "<string>",
"payment_method_type": "<string>",
"product_cart": [
{
"product_id": "<string>",
"quantity": 1
}
],
"refunds": [
{
"amount": 123,
"business_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "AED",
"payment_id": "<string>",
"reason": "<string>",
"refund_id": "<string>",
"status": "succeeded"
}
],
"status": "succeeded",
"subscription_id": "<string>",
"tax": 123,
"total_amount": 123,
"updated_at": "2023-11-07T05:31:56Z",
"payload_type": "Payment"
},
"timestamp": "2023-11-07T05:31:56Z",
"type": "payment.succeeded"
}'Headers
Unique identifier for the webhook
Signature of the Webhook
Unix timestamp when the webhook was sent
Body
Identifier of the business associated with the payment
Timestamp when the payment was created
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW List of disputes associated with this payment
The amount involved in the dispute, represented as a string to accommodate precision.
The unique identifier of the business involved in the dispute.
The timestamp of when the dispute was created, in UTC.
The currency of the disputed amount, represented as an ISO 4217 currency code.
The unique identifier of the dispute.
pre_dispute, dispute, pre_arbitration dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost The unique identifier of the payment associated with the dispute.
Unique identifier for the payment
List of refunds issued for this payment
The unique identifier of the business issuing the refund.
The timestamp of when the refund was created in UTC.
The unique identifier of the payment associated with the refund.
The unique identifier of the refund.
succeeded, failed, pending, review The refunded amount.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The reason provided for the refund, if any. Optional.
Total amount charged to the customer including tax, in smallest currency unit (e.g. cents)
Payment The discount id if discount is applied
An error message if the payment failed
Checkout URL
Payment method used by customer (e.g. "card", "bank_transfer")
Specific type of payment method (e.g. "visa", "mastercard")
succeeded, failed, cancelled, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable Identifier of the subscription if payment is part of a subscription
Amount of tax collected in smallest currency unit (e.g. cents)
Timestamp when the payment was last updated
The timestamp of when the event occurred (not necessarily the same of when it was delivered)
Event types for Dodo events
payment.succeeded, payment.failed, payment.processing, payment.cancelled, refund.succeeded, refund.failed, dispute.opened, dispute.expired, dispute.accepted, dispute.cancelled, dispute.challenged, dispute.won, dispute.lost, subscription.active, subscription.renewed, subscription.on_hold, subscription.paused, subscription.cancelled, subscription.failed, subscription.expired, license_key.created Response
Webhook processed successfully
curl --request POST \
--url https://test.dodopayments.com/your-webhook-url \
--header 'Content-Type: application/json' \
--header 'webhook-id: <webhook-id>' \
--header 'webhook-signature: <webhook-signature>' \
--header 'webhook-timestamp: <webhook-timestamp>' \
--data '{
"business_id": "<string>",
"data": {
"business_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "AED",
"customer": {
"customer_id": "<string>",
"email": "<string>",
"name": "<string>"
},
"discount_id": "<string>",
"disputes": [
{
"amount": "<string>",
"business_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"dispute_id": "<string>",
"dispute_stage": "pre_dispute",
"dispute_status": "dispute_opened",
"payment_id": "<string>"
}
],
"error_message": "<string>",
"metadata": {},
"payment_id": "<string>",
"payment_link": "<string>",
"payment_method": "<string>",
"payment_method_type": "<string>",
"product_cart": [
{
"product_id": "<string>",
"quantity": 1
}
],
"refunds": [
{
"amount": 123,
"business_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "AED",
"payment_id": "<string>",
"reason": "<string>",
"refund_id": "<string>",
"status": "succeeded"
}
],
"status": "succeeded",
"subscription_id": "<string>",
"tax": 123,
"total_amount": 123,
"updated_at": "2023-11-07T05:31:56Z",
"payload_type": "Payment"
},
"timestamp": "2023-11-07T05:31:56Z",
"type": "payment.succeeded"
}'