Event - Redeemables
This includes business-level information for redeemable events triggered as they happen in the Punchh system.
{
"content_id": "CONTENT_ID_GOES_HERE",
"timestamp": 1595588250,
"business_id": 1,
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"event_name": "redeemables",
"event_type": "",
"action": "create",
"payload": {
"applicable_as_loyalty_redemption": false,
"created_at": "2025-03-27T15:29:40Z",
"description": "test redeemable for event",
"discount_amount": null,
"discount_channel": null,
"expire_redemption_code_with_reward_end_date": null,
"expiry_date": null,
"expiry_days": 5,
"end_time": "2025-03-30T02:30:00Z",
"meta_data": null,
"name": "test redeemable for event",
"points_required_to_redeem": null,
"redeemable_id": 48,
"redeemable_image_url": "IMAGE_URL_GOES_HERE",
"redeemable_properties": null,
"redemption_expiry": 240,
"status": "draft",
"updated_at": "2025-03-28T07:52:43Z"
}
}
Meta Fields
Meta Fields are common attributes such as content_id, timestamp, etc. that are returned in event responses, providing additional information about events. Click here to view the descriptions of the attributes.
Response Parameters
| Payload | ||
| applicable_as_loyalty_redemption | Boolean | Enables redeemables to be allowed for loyalty reward redemption as well |
| created_at | Date | Date/time when the redeemable was created for an end-user in the system |
| description | String | Description of the redeemable that appears in the app. It should lure the end-users into redeeming. |
| discount_amount | Integer | Discount amount associated |
| discount_channel | String | Channels where the reward can be used. Possible values are: 1. "online_only" for online orders 2. "offline_only" for POS 3. "all" for both |
| expire_redemption_code_ with_reward_end_date |
Boolean | Allows the redemption code to expire along with the reward end date as configured |
| expiry_date | Date | Expiry date of the redeemable |
| expiry_days | Integer | Number of days after which the redeemable will expire once the user receives it |
| end_time | Date_time | Date and time when the redeemable will expire |
| meta_data | String | Meta data that can be added to a redeemable. This can be used to program mobile apps to have certain behavior when specific data are received from the server. Or it can be used as the business wants. This can be configured from the Punchh platform and has a maximum length of 255 characters. |
| name | String | Name of the redeemable |
| points_required_to_redeem | Integer | Value of points required to redeem a particular redeemable |
| redeemable_id | Integer | Unique ID to identify a redeemable in the system |
| redeemable_image_url | String | URL of the image that will be displayed in the app to depict the redeemable |
| redeemable_properties | String | Properties (e.g., “Merchandise”, “Food Item”, etc.) that can be added to a particular redeemable |
| redemption_expiry | Integer | Expiry of the redemption as configured |
| status | String | Status includes: activated, deactivated, draft, expired |
| updated_at | Date | Date/time when the redeemable was updated for an end-user in the system |
| expire_redemption_code_with_reward_end_date | Boolean | Whether or not the redemption code will automatically become invalid when the reward or promotion it is associated with expired |