Response body parameters
All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.
Event-specific data containing detailed information about the event. The data object for the
sale.created event contains the following parameters:Hide object parameters
Hide object parameters
The customer that made the purchase.
Show customer object
Show customer object
The click event that led to the sale.
Show click object
Show click object
{
"id": "evt_WHjyHhqsfYOrlJOOVJSoHXysD",
"event": "sale.created",
"createdAt": "2024-08-30T09:57:51.245Z",
"data": {
"eventName": "Purchased",
"customer": {
"id": "cus_1K09DJDEACR47NPYC93RM43WF",
"name": "John",
"email": "john@example.com",
"avatar": "https://example.com/john.jpeg",
"externalId": "",
"stripeCustomerId": null,
"country": null,
"sales": 0,
"saleAmount": 0,
"createdAt": "2024-08-30T09:57:51.245Z",
"firstSaleAt": null,
"subscriptionCanceledAt": null
},
"click": {
"id": "d0UtZqE0BZuBPrJS",
"timestamp": "2024-08-30T09:57:51.245Z",
"url": "https://github.com/dubinc/dub",
"country": "US",
"city": "San Francisco",
"region": "CA",
"continent": "NA",
"device": "Desktop",
"browser": "Chrome",
"os": "Mac OS",
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36",
"trigger": null,
"referer": "(direct)",
"refererUrl": "(direct)",
"qr": false,
"ip": "63.141.57.109"
},
"link": {
"id": "cm0faqkyn0001txvfwjfeq7gl",
"domain": "dub.sh",
"key": "79ys3WA",
"url": "https://github.com/dubinc/dub",
"trackConversion": true,
"externalId": null,
"tenantId": null,
"partnerId": "pn_1JRB6678XHGBZE95R5PH5QVGS",
"programId": "prog_CYCu7IMAapjkRpTnr8F1azjN",
"archived": false,
"expiresAt": null,
"expiredUrl": null,
"disabledAt": null,
"password": null,
"proxy": false,
"title": null,
"description": null,
"image": null,
"video": null,
"rewrite": false,
"doIndex": false,
"ios": null,
"android": null,
"geo": null,
"publicStats": false,
"folderId": null,
"tagId": null,
"tags": [],
"webhookIds": [],
"comments": null,
"shortLink": "https://dub.sh/79ys3WA",
"qrCode": "https://api.dub.co/qr?url=https://dub.sh/79ys3WA?qr=1",
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_term": null,
"utm_content": null,
"userId": "cm022rkcw0000ikt14mscg9sg",
"workspaceId": "ws_cm022sis60003ikt1syy7kfhl",
"clicks": 10,
"lastClicked": "2024-08-30T07:45:09.000Z",
"leads": 5,
"conversions": 1,
"sales": 1,
"saleAmount": 20000,
"createdAt": "2024-08-29T13:03:59.098Z",
"updatedAt": "2024-08-30T09:57:50.891Z",
"projectId": "cm022sis60003ikt1syy7kfhl",
"testVariants": null,
"testCompletedAt": null,
"testStartedAt": null
},
"partner": {
"id": "pn_1JRB6678XHGBZE95R5PH5QVGS",
"name": "Sarah Johnson",
"email": "sarah@partner.com",
"image": "https://example.com/sarah-avatar.jpg",
"payoutsEnabledAt": null,
"country": "US",
"groupId": "grp_1K6K3HD0QE7XTX5HSVR77AK5B",
"totalClicks": 200,
"totalLeads": 30,
"totalConversions": 20,
"totalSales": 15,
"totalSaleAmount": 75000,
"totalCommissions": 7500
},
"sale": {
"amount": 4500,
"currency": "usd",
"paymentProcessor": "stripe",
"invoiceId": null
},
"metadata": null
}
}