For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Get supportSee a Demo
HomeAPI ReferenceSDKs
HomeAPI ReferenceSDKs
    • SDKs
    • WebView
  • API Reference
      • POSTNotification Webhook
Get supportSee a Demo
API ReferenceNotifications

Notification Webhook

Payload
1{
2 "data": {
3 "type": "earnedRewardSettled",
4 "attributes": {
5 "attributionUrl": "www.attribution.com/token",
6 "commissionEarned": {
7 "type": "cents",
8 "value": 72
9 },
10 "message": "You have earned a 72 cent reward on your transaction at McDonald's",
11 "name": "McDonald's",
12 "transactionAmountInCents": 3000,
13 "transactionId": "019df940-babd-7cd3-acfc-a96de16643e9",
14 "cardProductId": "card_product_123",
15 "surveyUrl": "www.survey.com",
16 "transactionTimestamp": "2024-10-01T14:32:10.000Z"
17 },
18 "id": "d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
19 "relationships": {
20 "user": {
21 "data": {
22 "type": "user",
23 "id": "1234567890"
24 }
25 },
26 "offer": {
27 "data": {
28 "type": "offer",
29 "id": "12309123879"
30 }
31 },
32 "transaction": {
33 "data": {
34 "type": "transaction",
35 "id": "0987654321"
36 }
37 }
38 }
39 }
40}

This is an outbound webhook for issuers to receive notifications from Kard. Learn more about how to configure, ingest and trigger your notification webhooks here.

Was this page helpful?
Previous

Get Subscriptions

Next
Built with

Payload

The payload of this webhook request is an object.
dataobjectRequired
metaobjectOptional
errorslist of objectsOptional

Response

200
any
Return a 200 status to indicate that the data was received successfully.