GuidesAPI EndpointsChangelog
Guides

Events Payload

This document details the events(Webhook, SQS, etc) 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:

FieldTypeDescription
idstringUnique identifier for the event.
eventstringThe event type.
reward_transaction_idstringUnique ID of the reward transaction.
reward_item_idstringUnique ID of the reward item.
reward_item_amountnumberAmount of the reward item awarded.
reward_item_balancenumberRemaining balance of the reward item.
reward_action_idstringUnique ID of the action that triggered the reward.
reward_action_keystringKey of the action that triggered the reward.
reward_table_idstringID of the reward table.
client_idstringID of the client associated with the reward.
profile_idstringID of the profile receiving the reward.
profile_custom_idstringCustom identifier for the profile.
created_atstringTimestamp 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:

FieldTypeDescription
idstringUnique identifier for the event.
eventstringThe event type.
badge_idstringUnique ID of the badge.
earned_badge_idstringID of the earned badge instance.
badge_titlestringTitle of the badge.
descriptionstringDescription of the badge.
reward_item_idstringID of the reward item associated with the badge.
reward_item_namestringName of the reward item.
reward_item_thresholdnumberThreshold value for the reward item.
image_urlstringURL of the badge image.
client_idstringID of the client associated with the badge.
profile_idstringID of the profile receiving the badge.
profile_custom_idstringCustom identifier for the profile.
created_atstringTimestamp 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:

FieldTypeDescription
idstringUnique identifier for the event.
eventstringThe event type.
user_quest_task_idstringID of the user quest task.
user_quest_idstringID of the user quest.
quest_task_idstringID of the quest task.
quest_idstringID of the quest.
custom_incrementnumberCustom increment applied to task progress.
custom_progressnumberCustom progress value set for the task.
client_idstringID of the client.
profile_idstringID of the profile.
nicknamestringNickname of the profile.
created_atstringTimestamp 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:

FieldTypeDescription
idstringUnique identifier for the event.
eventstringThe event type.
user_quest_task_idstringID of the user quest task.
user_quest_idstringID of the user quest.
quest_task_idstringID of the quest task.
quest_idstringID of the quest.
created_atstringTimestamp when the event was created.
completed_atstringTimestamp when the task was completed.
statusstringStatus of the task.
progressnumberProgress made on the task.
client_idstringID of the client.
profile_idstringID of the profile.
nicknamestringNickname 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 NameTypeDescription
idstringUnique identifier for the event.
eventstringEvent type (user-quest-completed).
data.user_quest_idstringUnique identifier for the user quest.
data.profile_idstringUnique identifier for the user profile.
data.quest_idstringUnique identifier for the quest.
data.quest_task_idsarrayList of unique quest task identifiers associated with this quest.
data.created_atdatetimeTimestamp indicating when the user quest was created.
data.completed_atdatetimeTimestamp indicating when the user quest was completed.
data.active_untildatetimeIndicates until when the quest was active (if applicable).
data.timer_expiredbooleanIndicates if the quest timer expired.
data.user_quest_task_idsarrayList of unique user quest task identifiers completed for this quest.
data.statusstringStatus of the quest completion (e.g., completed).
data.rewards_statusstringStatus of rewards (e.g., unclaimed).
data.rewards_claimed_atdatetimeTimestamp when rewards were claimed (if applicable).
data.client_idstringClient-specific identifier.
data.nicknamestringNickname of the user.
created_atdatetimeTimestamp 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 NameTypeDescription
idstringUnique identifier for the event.
eventstringEvent type (user-reward-awarded).
data.reward_transaction_idstringUnique identifier for the reward transaction.
data.reward_item_idstringUnique identifier for the reward item.
data.reward_action_keystringKey representing the action associated with the reward.
data.reward_action_idstringUnique identifier for the action associated with the reward.
data.client_idstringClient-specific identifier.
data.reward_item_amountintegerAmount of reward items awarded.
data.profile_idstringUnique identifier for the user profile.
data.profile_custom_idstringCustom identifier for the user profile.
data.reward_item_balanceintegerCurrent balance of the reward item.
data.nicknamestringNickname of the user.
created_atdatetimeTimestamp when the event was created.

comment-created

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "comment-created",
  "data": {
    "comment_id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "author_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
    "author_nickname": "Charming Trout",
    "author_image_url": null,
		"author_custom_id": "customid",
    "comment_text": "Test Comment",
		"comment_board_id": "eab83c37-1e9e-4180-932f-b9fe27b14865",
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu",
    "created_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type comment-created
data.comment_idstringUnique identifier for the comment
data.author_nicknamestringNickname for the author of the comment
data.author_image_urlstringThe url for the profile image for the author of the comment
data.author_custom_idstringCustom id of comment creator (optional)
data.comment_textstringThe actual text content of the comment
data.comment_board_idstringThe id of the comment board
data.client_idstringClient-specific identifier
data.created_atstringTimestamp when the comment was created
created_atdatetimeTimestamp when the event was created

comment-reply-created

Payload Example:

{
  "id": "d611c646-eda9-44ff-84c1-38521775e43c",
  "event": "comment-reply-created",
  "data": {
    "reply_comment_id": "9fc9e53d-0325-467a-9b83-83a8c62e572b",
    "reply_author_id": "1da10aea-96b9-4842-83b7-257ed3953804",
    "reply_author_nickname": "Humble Hamster",
    "reply_author_image_url": null,
		"reply_author_custom_id": "cuid",
    "reply_text": "Test Comment Reply 2",
    "comment_id": "51cc5522-6967-46ff-8edb-afbe90e5e3d5",
    "author_id": "947d3a03-f87f-4146-8e32-043db3fdd25f",
    "author_nickname": "Swift Zebra",
    "author_image_url": null,
		"author_custom_id": "customid",
    "comment_text": "Test Comment",
		"comment_board_id": "eab83c37-1e9e-4180-932f-b9fe27b14865",
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu",
    "created_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type comment-reply-created
data.reply_comment_idstringUnique identifier for the comment reply
data.reply_author_idstringUnique identifier for the author of the new comment reply
data.reply_author_nicknamestringNickname for the author of the new comment reply
data.reply_author_custom_idstringCusto id for the author of the comment reply (optional)
data.reply_textstringThe actual text content of the new comment reply
data.author_idstringUnique identifier for the author of the original comment
data.comment_idstringUnique identifier for the original comment to which the reply was given
data.author_nicknamestringNickname for the author of the original comment
data.author_image_urlstringThe url for the profile image for the author of the original comment
data.author_custom_idstringCustom id of original comment creator
data.comment_textstringThe actual text content of the original comment
data.comment_board_idstringThe id of the comment board
data.client_idstringClient-specific identifier
data.created_atstringTimestamp when the comment reply was created
created_atdatetimeTimestamp when the event was created

comment-mention-created

Payload Example:

{
  "id": "26059f13-9864-4507-a19c-5891bbac5beb",
  "event": "comment-mention-created",
  "data": {
    "profile_id": "947d3a03-f87f-4146-8e32-043db3fdd25f",
    "profile_custom_id": "customid",
		"profile_nickname": "Charming Throut",
    "mentioned_by_id": "ce74ad6c-496d-48da-85a6-9b6d83367598",
    "mentioned_by_custom_id": "mentioned_custom_id",
		"mentioned_by_nickname": "Swift Zebra",
    "comment_id": "ce1b34f3-2cdf-4145-87ee-e9c2279f838f",
    "comment_text": "Hey @Swift and @Witty, how are you?",
    "start_index": 4,
    "end_index": 9,
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu",
    "parent_comment_id": "76a33123-ff4c-4509-a31e-4db5880d8151",
    "parent_comment_author_id": "bf6051b5-2406-4304-b047-0ff4074c17a0",
		"parent_comment_author_custom_id": "thisisid",
    "parent_comment_author_nickname": "Loyal Falcon",
		"comment_board_id": "eab83c37-1e9e-4180-932f-b9fe27b14865",
    "created_at": "2025-09-10T06:27:03.349873Z"
  },
  "created_at": "2025-09-10T06:27:03.629615+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type comment-mention-created
data.profile_idstringUnique identifier for the mentioned profile
data.profile_custom_idstringCustom id of mentioned profile
data.profile_nicknamestringNickname of mentioned profile
data.mentioned_by_idstringUnique identifier for the mentioned_by profile
data.mentioned_by_custom_idstringMentioned by custom id
data.mentioned_by_nicknamestringMentioned by nickname
data.comment_idstringUnique identifier for the comment
data.comment_textstringText content of the comment in which mentions were created
data.start_indexstringStarting index of the mention placeholder in the comment text
data.end_indexstringEnding index of the mention placeholder in the comment text
data.client_idstringClient-specific identifier
data.parent_comment_idstringParent comment id (in mention reply only, optional)
data.parent_comment_author_idstringParent comment author id (in mention reply only, optional)
data.parent_comment_author_custom_idstringParent comment author custom id (in mention reply only, optional)
data.comment_board_idstringThe id of the comment board
data.created_atdatetimeTimestamp when the comment mention was created
created_atdatetimeTimestamp when the event was created

profile-relationship-created

Payload Example:

{
  "id": "81b4d144-2936-44b7-867b-8c8740dc6159",
  "event": "profile-relationship-created",
  "data": {
    "relationship_type": "follow",
    "to_profile_id": "31d9b4b0-7ef6-44f8-911c-96035700c7d8",
    "to_profile_nickname": "Charming Throut",
    "to_profile_custom_id": "thisisid",
    "is_active": true,
    "profile_id": "ce74ad6c-496d-48da-85a6-9b6d83367598",
    "profile_nickname": "Swift Zebra",
    "profile_custom_id": "customid",
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu",
    "created_at": "2025-09-10T07:01:46Z"
  },
  "created_at": "2025-09-10T07:02:16.062427+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type profile-relationship-created
data.relationship_typestringUnique key for profile relationship type
data.to_profile_idstringUnique identifier for the from profile in the relationship
data.to_profile_nicknamestringNickname for the from profile in the relationship
data.to_profile_custom_idstringCustomid for the from profile in the relationship
data.is_activebooleanActive status for the profile relationship
data.profile_idstringUnique identifier for the to profile in the relationship
data.profile_nicknamestringNickname for the to profile in the relationship
data.profile_custom_idstringCustom id for the to profile in the relationship
data.client_idstringClient-specific identifier
data.created_atdatetimeTimestamp when the profile relationship was created
created_atdatetimeTimestamp when the event was created

chat-mention-created

Payload Example:

{
  "id": "53158ddc-fb10-422e-9b14-60961aebd251",
  "event": "chat-mention-created",
  "data": {
    "profile_id": "947d3a03-f87f-4146-8e32-043db3fdd25f",
    "message_id": "ed247acc-36bf-444c-a9cc-da495b787fc1",
    "message": "Test Chat Message asjhfbkjhsabfgkjhsabf",
    "mentioned_by_id": "413739c8-a040-4832-ba44-186e05d590ca",
    "start_index": 10,
    "end_index": 15,
    "created_at": "2025-09-18T10:19:07.989634Z",
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu"
  },
  "created_at": "2025-09-18T10:19:09.263052+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type chat-mention-created
data.profile_idstringUnique identifier for the mentioned profile
data.mentioned_by_idstringUnique identifier for the mentioned_by profile
data.message_idstringUnique identifier for the chat
data.messagestringText content of the chat message in which mentions were created
data.start_indexstringStarting index of the mention placeholder in the message text
data.end_indexstringEnding index of the mention placeholder in the message text
data.client_idstringClient-specific identifier
data.created_atdatetimeTimestamp when the chat mention was created
created_atdatetimeTimestamp when the event was created

role-assignment-created

Payload Example:

{
  "id": "7ffdf932-c6f6-47fd-ae80-2cd560404172",
  "event": "role-assignment-created",
  "data": {
    "profile_id": "96e3ffe4-70c6-4abe-85b3-16c57327b29f",
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu",
    "role_id": "3cbc1aaa-530a-4335-ab8f-d7e015676c36",
    "role_key": "custom-widget-publisher",
    "scope_id": "fff01e6a-f93c-4e8d-b614-342381d5c704",
    "created_at": "2025-12-17T10:19:40.883240Z"
  },
  "created_at": "2025-12-17T10:19:40.939632+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type role-assignment-created
data.profile_idstringUnique identifier for the profile the role is assigned to
data.client_idstringClient-specific identifier
data.role_idstringUnique identifier for the role being assigned
data.role_keystringUnique key for the role being assigned
data.scope_idstringUnique identifier for the scope the role is assigned in
data.created_atdatetimeTimestamp when the role assignment was created
created_atdatetimeTimestamp when the event was created

flair-created

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-created",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
    "name": "Influencer",
		"description": "",
    "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
    "text_color": "#413EEB",
    "background_color": "#FFFFFF",
		"is_active": true,
    "attributes": [],
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-created
data.idstringUnique identifier for the flair
data.client_idstringClient-specific identifier
data.namestringName of the flair
data.descriptionstringDescription of the flair
data.imagestringImage url of the flair
data.text_colorstringColor of the text in the flair
data.background_colorstringBackground color of the flair
data.is_activebooleanIs the flair active
data.attributesarrayAttributes of the flair
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

flair-updated

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-updated",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
    "name": "Influencer",
		"description": "",
    "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
    "text_color": "#413EEB",
    "background_color": "#FFFFFF",
		"is_active": true,
    "attributes": [],
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-updated
data.idstringUnique identifier for the flair
data.client_idstringClient-specific identifier
data.namestringName of the flair
data.descriptionstringDescription of the flair
data.imagestringImage url of the flair
data.text_colorstringColor of the text in the flair
data.background_colorstringBackground color of the flair
data.is_activebooleanIs the flair active
data.attributesarrayAttributes of the flair
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

flair-deactivated

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-deactivated",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
    "name": "Influencer",
		"description": "",
    "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
    "text_color": "#413EEB",
    "background_color": "#FFFFFF",
		"is_active": true,
    "attributes": [],
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-deactivated
data.idstringUnique identifier for the flair
data.client_idstringClient-specific identifier
data.namestringName of the flair
data.descriptionstringDescription of the flair
data.imagestringImage url of the flair
data.text_colorstringColor of the text in the flair
data.background_colorstringBackground color of the flair
data.is_activebooleanIs the flair active
data.attributesarrayAttributes of the flair
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

flair-reactivated

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-reactivated",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
    "name": "Influencer",
		"description": "",
    "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
    "text_color": "#413EEB",
    "background_color": "#FFFFFF",
		"is_active": true,
    "attributes": [],
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-reactivated
data.idstringUnique identifier for the flair
data.client_idstringClient-specific identifier
data.namestringName of the flair
data.descriptionstringDescription of the flair
data.imagestringImage url of the flair
data.text_colorstringColor of the text in the flair
data.background_colorstringBackground color of the flair
data.is_activebooleanIs the flair active
data.attributesarrayAttributes of the flair
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

flair-assignment-created

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-assignment-created",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "is_active": true,
    "assigned_by_id": "<uuid>",
    "assigned_by_nickname": "Charming Trout",
    "assigned_by_custom_id": "<assigned by profile's custom id>",
		"profile_id": "ddacd28b-93da-4d05-9ea6-eeed35e74d90",
    "flair": {
      "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
      "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
      "name": "Influencer",
      "description": "",
      "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
      "text_color": "#413EEB",
      "background_color": "#FFFFFF",
      "is_active": true,
      "attributes": [],
      "created_at": "2025-06-03T08:00:20.567272Z",
      "updated_at": "2025-06-03T08:00:20.567272Z"
		},
		"scope": null,
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-assignment-created
data.idstringUnique identifier for the flair
data.is_activebooleanIs the flair assignment active
data.assigned_bystringName of the profile which created assignment
data.profile_idstringProfile id of the profile on which flair is assigned
data.flairobjectFlair which is assigned
data.scopeobject | nullScope of the assignment
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

flair-assignment-updated

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-assignment-updated",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "is_active": true,
    "assigned_by_id": "<uuid>",
    "assigned_by_nickname": "Charming Trout",
    "assigned_by_custom_id": "<assigned by profile's custom id>",
		"profile_id": "ddacd28b-93da-4d05-9ea6-eeed35e74d90",
    "flair": {
      "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
      "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
      "name": "Influencer",
      "description": "",
      "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
      "text_color": "#413EEB",
      "background_color": "#FFFFFF",
      "is_active": true,
      "attributes": [],
      "created_at": "2025-06-03T08:00:20.567272Z",
      "updated_at": "2025-06-03T08:00:20.567272Z"
		},
		"scope": null,
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-assignment-updated
data.idstringUnique identifier for the flair
data.is_activebooleanIs the flair assignment active
data.assigned_bystringName of the profile which created assignment
data.profile_idstringProfile id of the profile on which flair is assigned
data.flairobjectFlair which is assigned
data.scopeobject | nullScope of the assignment
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

flair-assignment-deleted

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "flair-assignment-deleted",
  "data": {
    "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "is_active": true,
    "assigned_by_id": "<uuid>",
    "assigned_by_nickname": "Charming Trout",
    "assigned_by_custom_id": "<assigned by profile's custom id>",
		"profile_id": "ddacd28b-93da-4d05-9ea6-eeed35e74d90",
    "flair": {
      "id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
      "client_id": "56ded114-cb29-4853-9c22-96068cfd23e0",
      "name": "Influencer",
      "description": "",
      "image": "{live_like}/media/flairs/b3435235-18eb-4115-ba05-71ff28a06429.svg",
      "text_color": "#413EEB",
      "background_color": "#FFFFFF",
      "is_active": true,
      "attributes": [],
      "created_at": "2025-06-03T08:00:20.567272Z",
      "updated_at": "2025-06-03T08:00:20.567272Z"
		},
		"scope": null,
    "created_at": "2025-06-03T08:00:20.567272Z",
    "updated_at": "2025-06-03T08:00:20.567272Z"
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type flair-assignment-deleted
data.idstringUnique identifier for the flair
data.is_activebooleanIs the flair assignment active
data.assigned_bystringName of the profile which created assignment
data.profile_idstringProfile id of the profile on which flair is assigned
data.flairobjectFlair which is assigned
data.scopeobject | nullScope of the assignment
data.created_atstringTimestamp when the flair was created
data.updated_atstringTimestamp when flair was updated
created_atdatetimeTimestamp when the event was created

user-reaction-created , user-reaction-deleted

Payload Example:

{
  "id": "782e5b83-9213-4d2a-90c6-767dc0c26db5",
  "event": "user-reaction-created" | "user-reaction-deleted",
  "data": {
    "reaction_name": "smile_emoji",
    "reaction_id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "target_id": "b78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "target_id": "comment",
    "user_reaction_id": "e78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "reaction_space_id": "a78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "reaction_space_target_group_id": "f78039c1-1d79-4689-a373-aa00c7ea0fe3",
    "reaction_created_by_id": "ddacd28b-93da-4d05-9ea6-eeed35e74d90",
    "reaction_created_by_custom_id": "thisisid",
    "reaction_created_by_nickname": "Charming Throut",
    "created_at": "2025-06-03T08:00:20.766704+00:00",
    "deleted_at": "2025-06-03T08:00:21.766704+00:00"  //available only in user-reaction-deleted event
  },
  "created_at": "2025-06-03T08:00:20.766704+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type user-reaction-created for create and user-reaction-deleted for delete
data.reaction_space_idstringUnique identified of reaction space
data.reaction_space_target_group_idstringTarget id for rection space
data.reaction_created_by_idstringUser id of the user created reaction
data.reaction_created_by_nicknamestringUser nickname of the user created reaction
data.reaction_created_by_custom_idstringUser custom id of the user created reaction
data.reaction_namestringName of the reaction
data.reaction_idstringId of the reaction
data.user_reaction_idstringId of user reaction
data.target_idstringId of the target where reaction is applied
data.target_typestringType of the target/entity where reaction is applied. if not provided during creation time, it remains null
created_atdatetimeTimestamp when the event was created

chat-message-throttle-updated

Payload Example:

{
  "id": "f138c104-c987-4c24-8eb5-4bc555b149f2",
  "event": "chat-message-throttle-updated",
  "data": {
    "chat_room_id": "8c479fe1-761d-4ef3-8d61-91c95066fdd2",
    "chat_message_throttle_seconds": 5,
    "title": "Test Chat Room 3",
    "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu"
  },
  "created_at": "2025-12-26T13:27:45.141277+00:00"
}

Field Descriptions

Field NameTypeDescription
idstringUnique identifier for the event
eventstringEvent type chat-message-throttle-updated
data.chat_room_idstringUnique identifier for the chat room that was updated
data.client_idstringClient-specific identifier
data.titlestringTitle of the chat room that was updated
data.chat_message_throttle_secondsstringThe updated chat throttle time in seconds
created_atdatetimeTimestamp when the event was created

Notes

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

Updated 6 days ago