Webhook Requests
When a webhook event occurs in Lemon Squeezy, a POST request with event-specific JSON data is sent to the configured URL, requiring a 200 response for successful capture, with up to three retries using exponential backoff if the initial attempt fails.
When a webhook event occurs in Lemon Squeezy, a POST request will be sent to the configured webhook URL.
Return a 200 response to show that the webhook was successfully captured. If the response status is anything else, the webhook will be retried up to three more times using an exponential backoff strategy (e.g. 5 secs, 25 secs, 125 secs) at which point the request will be considered failed and will no longer be retried.
The webhook body will be a JSON:API resource object that relates to the event (e.g. “order” events will be sent an order object, “subscription” events will be sent a subscription object, etc).
The request headers will include:
- A
Content-Typeheader set toapplication/json. - An
X-Event-Nameheader with the name of the event that triggered the webhook. - An
X-Signatureheader containing the request signature. Read on for information about verifying signatures.
If a webhook is configured to send a request to an HTTPS URL, the SSL certificate of the URL will be verified before sending the request.
If you have added custom data to your checkout, you will find a custom_data object inside the meta field for all Order, Subscription and License key related events.
Content-Type: application/json
X-Event-Name: order_created
X-Signature: {signature}{
"meta": {
"event_name": "order_created",
"custom_data": {
"customer_id": 25
}
},
"data": {
"type": "orders",
"id": "1",
"attributes": {
"store_id": 1,
"customer_id": 1,
"identifier": "104e18a2-d755-4d4b-80c4-a6c1dcbe1c10",
"order_number": 1,
"user_name": "John Doe",
"user_email": "[email protected]",
"currency": "USD",
"currency_rate": "1.0000",
"subtotal": 999,
"discount_total": 0,
"tax": 200,
"total": 1199,
"subtotal_usd": 999,
"discount_total_usd": 0,
"tax_usd": 200,
"total_usd": 1199,
"tax_name": "VAT",
"tax_rate": "20.00",
"status": "paid",
"status_formatted": "Paid",
"refunded": false,
"refunded_at": null,
"subtotal_formatted": "$9.99",
"discount_total_formatted": "$0.00",
"tax_formatted": "$2.00",
"total_formatted": "$11.99",
"first_order_item": {
"id": 1,
"order_id": 1,
"product_id": 1,
"variant_id": 1,
"product_name": "Test Limited License for 2 years",
"variant_name": "Default",
"price": 1199,
"created_at": "2021-08-17T09:45:53.000000Z",
"updated_at": "2021-08-17T09:45:53.000000Z",
"deleted_at": null,
"test_mode": false
},
"urls": {
"receipt": "https://app.lemonsqueezy.com/my-orders/104e18a2-d755-4d4b-80c4-a6c1dcbe1c10?signature=8847fff02e1bfb0c7c43ff1cdf1b1657a8eed2029413692663b86859208c9f42"
},
"created_at": "2021-08-17T09:45:53.000000Z",
"updated_at": "2021-08-17T09:45:53.000000Z"
},
"relationships": {
"store": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/orders/1/store",
"self": "https://api.lemonsqueezy.com/v1/orders/1/relationships/store"
}
},
"customer": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/orders/1/customer",
"self": "https://api.lemonsqueezy.com/v1/orders/1/relationships/customer"
}
},
"order-items": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/orders/1/order-items",
"self": "https://api.lemonsqueezy.com/v1/orders/1/relationships/order-items"
}
},
"subscriptions": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/orders/1/subscriptions",
"self": "https://api.lemonsqueezy.com/v1/orders/1/relationships/subscriptions"
}
},
"license-keys": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/orders/1/license-keys",
"self": "https://api.lemonsqueezy.com/v1/orders/1/relationships/license-keys"
}
},
"discount-redemptions": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/orders/1/discount-redemptions",
"self": "https://api.lemonsqueezy.com/v1/orders/1/relationships/discount-redemptions"
}
}
},
"links": {
"self": "https://api.lemonsqueezy.com/v1/orders/1"
}
}
}