Create Subscriptions

POST

/v2/issuers/:organizationId/subscriptions

Call this endpoint to subscribe to notification events.
Required scopes: notifications:write

Path parameters

organizationIdstringRequired

Your issuer organization ID, provided by Kard

Request

This endpoint expects an object.

datalist of objectsRequired

Response

This endpoint returns an object.

datalist of objects

Errors

POST

1 curl -X POST https://rewards-api.getkard.com/v2/issuers/{organizationId}/subscriptions \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "data": [
6     {
7       "type": "subscription",
8       "attributes": {
9         "eventName": "earnedRewardApproved",
10         "webhookUrl": "https://webhookUrl.com/post",
11         "enabled": true
12       }
13     }
14   ]
15 }'

1 {
2   "data": [
3     {
4       "type": "subscription",
5       "attributes": {
6         "issuerId": "00001234",
7         "eventName": "earnedRewardApproved",
8         "webhookUrl": "https://webhookUrl.com/post",
9         "enabled": true,
10         "createdAt": "2024-12-11T00:11:00.390Z",
11         "updatedAt": "2024-12-11T00:11:00.390Z"
12       },
13       "id": "0193i257-014e-7dd2-9455-fb964d9c85cr"
14     }
15   ]
16 }

Built with

1	curl -X POST https://rewards-api.getkard.com/v2/issuers/{organizationId}/subscriptions \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"data": [
6	{
7	"type": "subscription",
8	"attributes": {
9	"eventName": "earnedRewardApproved",
10	"webhookUrl": "https://webhookUrl.com/post",
11	"enabled": true
12	}
13	}
14	]
15	}'