Webhook Events Payload

This document details the webhook events sent by our system, including their payload structures and descriptions of each field.

`reward-table-rewards-awarded`

Payload Structure:

{
    "id": "76f574bd-c986-40a2-84fe-5e551fdfe375",
    "event": "reward-table-rewards-awarded",
    "data": {
        "reward_transaction_id": "reward-transaction-id",
        "reward_item_id": "reward-item-uuid",
        "reward_item_amount": 100,
        "reward_item_balance": 1000,
        "reward_action_id": "action-uuid",
        "reward_action_key": "play-game",
        "reward_table_id": "table-uuid",
        "client_id": "client-id",
        "profile_id": "profile-uuid",
        "profile_custom_id": "custom-id"
    },
    "created_at": "2024-09-02T12:34:56Z"
}

Field Descriptions:

Field	Type	Description
`id`	string	Unique identifier for the webhook event.
`event`	string	The event type.
`reward_transaction_id`	string	Unique ID of the reward transaction.
`reward_item_id`	string	Unique ID of the reward item.
`reward_item_amount`	number	Amount of the reward item awarded.
`reward_item_balance`	number	Remaining balance of the reward item.
`reward_action_id`	string	Unique ID of the action that triggered the reward.
`reward_action_key`	string	Key of the action that triggered the reward.
`reward_table_id`	string	ID of the reward table.
`client_id`	string	ID of the client associated with the reward.
`profile_id`	string	ID of the profile receiving the reward.
`profile_custom_id`	string	Custom identifier for the profile.
`created_at`	string	Timestamp when the event was created.

`badge-awarded`

Payload Structure:

{
    "id": "76f574bd-c986-40a2-84fe-5e551fdfe375",
    "event": "badge-awarded",
    "data": {
        "badge_id": "badge-id",
        "earned_badge_id": "earned_badge_id",
        "badge_title": "Badge Title",
        "description": "Badge Description",
        "reward_item_id": "reward-item-id",
        "reward_item_name": "Reward Item Name",
        "reward_item_threshold": 10,
        "image_url": "https://example.com/image.png",
        "client_id": "client-id",
        "profile_id": "profile-uuid",
        "profile_custom_id": "custom-id"
    },
    "created_at": "2024-09-02T12:34:56Z"
}

Field Descriptions:

Field	Type	Description
`id`	string	Unique identifier for the webhook event.
`event`	string	The event type.
`badge_id`	string	Unique ID of the badge.
`earned_badge_id`	string	ID of the earned badge instance.
`badge_title`	string	Title of the badge.
`description`	string	Description of the badge.
`reward_item_id`	string	ID of the reward item associated with the badge.
`reward_item_name`	string	Name of the reward item.
`reward_item_threshold`	number	Threshold value for the reward item.
`image_url`	string	URL of the badge image.
`client_id`	string	ID of the client associated with the badge.
`profile_id`	string	ID of the profile receiving the badge.
`profile_custom_id`	string	Custom identifier for the profile.
`created_at`	string	Timestamp when the event was created.

`user-quest-task-progressed`

Payload Structure:

{
    "id": "f5967a2f-6fae-4801-9708-189ec59200c9",
    "event": "user-quest-task-progressed",
    "data": {
        "user_quest_task_id": "38a70a0a-c578-4a86-a178-410d8ba58415",
        "user_quest_id": "5998109b-403a-4e88-b38b-1cc98bce9b9e",
        "quest_task_id": "e60c13a4-fe32-4798-b803-4db143355d00",
        "quest_id": "82c81919-c413-41c7-94a8-927040197e27",
        "custom_increment": null,
        "custom_progress": null,
        "client_id": "client-id",
        "profile_id": "profile-id",
        "nickname": "Composed Keeper"
    },
    "created_at": "2024-12-18T12:40:32.993163+00:00"
}

Field Descriptions:

Field	Type	Description
`id`	string	Unique identifier for the webhook event.
`event`	string	The event type.
`user_quest_task_id`	string	ID of the user quest task.
`user_quest_id`	string	ID of the user quest.
`quest_task_id`	string	ID of the quest task.
`quest_id`	string	ID of the quest.
`custom_increment`	number	Custom increment applied to task progress.
`custom_progress`	number	Custom progress value set for the task.
`client_id`	string	ID of the client.
`profile_id`	string	ID of the profile.
`nickname`	string	Nickname of the profile.
`created_at`	string	Timestamp when the event was created.

`user-quest-task-completed`

Payload Structure:

{
    "id": "e92490c7-934a-477e-9423-62832263bb83",
    "event": "user-quest-task-completed",
    "data": {
        "user_quest_task_id": "65427b29-5b53-4452-9f79-dda23b4051fa",
        "user_quest_id": "e7ca598c-0feb-4385-9a83-525b5bff01b5",
        "quest_task_id": "74006b3b-5b86-4798-9a57-7b0a654b7515",
        "quest_id": "48402f0c-ea5f-4d3f-bedc-e754ec21f1d8",
        "created_at": "2024-12-18T12:28:24Z",
        "completed_at": "2024-12-18T12:40:04Z",
        "status": "completed",
        "progress": 3,
        "client_id": "client-id",
        "profile_id": "profile-id",
        "nickname": "Composed Keeper"
    },
    "created_at": "2024-12-18T12:41:24.826896+00:00"
}

Field Descriptions:

Field	Type	Description
`id`	string	Unique identifier for the webhook event.
`event`	string	The event type.
`user_quest_task_id`	string	ID of the user quest task.
`user_quest_id`	string	ID of the user quest.
`quest_task_id`	string	ID of the quest task.
`quest_id`	string	ID of the quest.
`created_at`	string	Timestamp when the event was created.
`completed_at`	string	Timestamp when the task was completed.
`status`	string	Status of the task.
`progress`	number	Progress made on the task.
`client_id`	string	ID of the client.
`profile_id`	string	ID of the profile.
`nickname`	string	Nickname of the profile.

`user-quest-completed`

Payload Example:

{
  "id": "0abc42d4-6520-47f4-9896-5a485642d4a7",
  "event": "user-quest-completed",
  "data": {
    "user_quest_id": "e7ca598c-0feb-4385-9a83-525b5bff01b5",
    "profile_id": "5f724202-246d-439b-8250-527bed44b6c9",
    "quest_id": "48402f0c-ea5f-4d3f-bedc-e754ec21f1d8",
    "quest_task_ids": ["74006b3b-5b86-4798-9a57-7b0a654b7515"],
    "created_at": "2024-12-18T12:28:24Z",
    "completed_at": "2024-12-18T12:40:04Z",
    "active_until": null,
    "timer_expired": false,
    "user_quest_task_ids": ["65427b29-5b53-4452-9f79-dda23b4051fa"],
    "status": "completed",
    "rewards_status": "unclaimed",
    "rewards_claimed_at": null,
    "client_id": "8PqSNDgIVHnXuJuGte1HdvOjOqhCFE1ZCR3qhqaS",
    "nickname": "Composed Keeper"
  },
  "created_at": "2024-12-18T12:41:24.825620+00:00"
}

Field Descriptions:

Field Name	Type	Description
`id`	`string`	Unique identifier for the event.
`event`	`string`	Event type (`user-quest-completed`).
`data.user_quest_id`	`string`	Unique identifier for the user quest.
`data.profile_id`	`string`	Unique identifier for the user profile.
`data.quest_id`	`string`	Unique identifier for the quest.
`data.quest_task_ids`	`array`	List of unique quest task identifiers associated with this quest.
`data.created_at`	`datetime`	Timestamp indicating when the user quest was created.
`data.completed_at`	`datetime`	Timestamp indicating when the user quest was completed.
`data.active_until`	`datetime`	Indicates until when the quest was active (if applicable).
`data.timer_expired`	`boolean`	Indicates if the quest timer expired.
`data.user_quest_task_ids`	`array`	List of unique user quest task identifiers completed for this quest.
`data.status`	`string`	Status of the quest completion (e.g., `completed`).
`data.rewards_status`	`string`	Status of rewards (e.g., `unclaimed`).
`data.rewards_claimed_at`	`datetime`	Timestamp when rewards were claimed (if applicable).
`data.client_id`	`string`	Client-specific identifier.
`data.nickname`	`string`	Nickname of the user.
`created_at`	`datetime`	Timestamp when the event was created.

`user-quest-reward-awarded`

Payload Example:

{
  "id": "7ff896cd-ac8d-4923-95ae-faf162ad2d1e",
  "event": "user-reward-awarded",
  "data": {
    "reward_transaction_id": "7815655b-03ef-4bb3-8c53-916512bff80c",
    "reward_item_id": "4c7bd24e-e0eb-4e07-8472-72e4f52ec4ae",
    "reward_action_key": "poll-voted",
    "reward_action_id": "3bb7b84a-5bcc-4539-bb52-c36b5d410d03",
    "client_id": "8PqSNDgIVHnXuJuGte1HdvOjOqhCFE1ZCR3qhqaS",
    "reward_item_amount": 100,
    "profile_id": "5f724202-246d-439b-8250-527bed44b6c9",
    "profile_custom_id": "[email protected]",
    "reward_item_balance": 260,
    "nickname": "Composed Keeper"
  },
  "created_at": "2024-12-18T13:31:03.927324+00:00"
}

Field Descriptions:

Field Name	Type	Description
`id`	`string`	Unique identifier for the event.
`event`	`string`	Event type (`user-reward-awarded`).
`data.reward_transaction_id`	`string`	Unique identifier for the reward transaction.
`data.reward_item_id`	`string`	Unique identifier for the reward item.
`data.reward_action_key`	`string`	Key representing the action associated with the reward.
`data.reward_action_id`	`string`	Unique identifier for the action associated with the reward.
`data.client_id`	`string`	Client-specific identifier.
`data.reward_item_amount`	`integer`	Amount of reward items awarded.
`data.profile_id`	`string`	Unique identifier for the user profile.
`data.profile_custom_id`	`string`	Custom identifier for the user profile.
`data.reward_item_balance`	`integer`	Current balance of the reward item.
`data.nickname`	`string`	Nickname of the user.
`created_at`	`datetime`	Timestamp when the event was created.

Notes

All id fields are UUIDs (Universally Unique Identifiers).
Timestamps follow the ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
Additional events will follow a similar structure and will be documented as they are added.