Events
Generated reference for Storyden plugin event payloads.
This page is generated from api/common/events.yaml.
Generated by internal/tools/rpcdocgen. Edit schema, not this page.
Related pages:
Events
EventThreadPublished
Emitted when a thread is visible as published, either on create or after a visibility change.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadPublished | Yes | - |
id | string (postID) | Yes | Thread post ID |
EventThreadUnpublished
Emitted when a previously published thread transitions to a non-published visibility.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadUnpublished | Yes | - |
id | string (postID) | Yes | Thread post ID |
EventThreadUpdated
Emitted after a thread update succeeds, regardless of which fields changed.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadUpdated | Yes | - |
id | string (postID) | Yes | Thread post ID |
EventThreadDeleted
Emitted after a thread is deleted.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadDeleted | Yes | - |
id | string (postID) | Yes | Thread post ID |
EventThreadReplyCreated
Emitted when a new reply is created and remains published (not moved to review by moderation).
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadReplyCreated | Yes | - |
reply_author_id | string (accountID) | Yes | Reply author account ID |
reply_id | string (postID) | Yes | Reply post ID |
reply_to_author_id | string (accountID) | No | Optional ID of the author being replied to |
reply_to_target_id | string (postID) | No | Optional ID of the post being replied to |
thread_author_id | string (accountID) | Yes | Thread author account ID |
thread_id | string (postID) | Yes | Thread post ID |
EventThreadReplyDeleted
Emitted after a reply is deleted from a thread.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadReplyDeleted | Yes | - |
reply_id | string (postID) | Yes | Reply post ID |
thread_id | string (postID) | Yes | Thread post ID |
EventThreadReplyUpdated
Emitted after a reply update succeeds.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadReplyUpdated | Yes | - |
reply_id | string (postID) | Yes | Reply post ID |
thread_id | string (postID) | Yes | Thread post ID |
EventThreadReplyPublished
Emitted when a reply visibility transitions to published.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadReplyPublished | Yes | - |
reply_id | string (postID) | Yes | Reply post ID |
thread_id | string (postID) | Yes | Thread post ID |
EventThreadReplyUnpublished
Emitted when a previously published reply transitions to a non-published visibility.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventThreadReplyUnpublished | Yes | - |
reply_id | string (postID) | Yes | Reply post ID |
thread_id | string (postID) | Yes | Thread post ID |
EventPostLiked
Emitted when a member adds a like to a post.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventPostLiked | Yes | - |
post_id | string (postID) | Yes | Post ID that was liked |
root_post_id | string (postID) | Yes | Root thread post ID |
EventPostUnliked
Emitted when a member removes a like from a post.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventPostUnliked | Yes | - |
post_id | string (postID) | Yes | Post ID that was unliked |
root_post_id | string (postID) | Yes | Root thread post ID |
EventPostReacted
Emitted when a member adds an emoji reaction to a post.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventPostReacted | Yes | - |
post_id | string (postID) | Yes | Post ID that was reacted to |
root_post_id | string (postID) | Yes | Root thread post ID |
EventPostUnreacted
Emitted when a member removes an emoji reaction from a post.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventPostUnreacted | Yes | - |
post_id | string (postID) | Yes | Post ID that was unreacted |
root_post_id | string (postID) | Yes | Root thread post ID |
EventCategoryUpdated
Emitted when a category is created, updated, or moved.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventCategoryUpdated | Yes | - |
id | string (xid) | Yes | Category ID |
slug | string | Yes | Category slug |
EventCategoryDeleted
Emitted after a category is deleted.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventCategoryDeleted | Yes | - |
id | string (xid) | Yes | Category ID |
slug | string | Yes | Category slug |
EventMemberMentioned
Emitted once per mention target when a member mention is detected (self-mentions are skipped).
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventMemberMentioned | Yes | - |
by | string (accountID) | Yes | Account ID of the member who mentioned |
item | DatagraphRef | Yes | Reference to the mentioned item. |
source | DatagraphRef | Yes | Reference to the content item where the mention was found. |
EventNodeCreated
Emitted after a library node is created.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventNodeCreated | Yes | - |
id | string (nodeID) | Yes | Library node ID |
slug | string | Yes | Node slug |
EventNodeUpdated
Emitted after a library node is updated, moved, re-ordered, or affected by property schema changes.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventNodeUpdated | Yes | - |
id | string (nodeID) | Yes | Library node ID |
slug | string | Yes | Node slug |
EventNodeDeleted
Emitted after a library node is deleted.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventNodeDeleted | Yes | - |
id | string (nodeID) | Yes | Library node ID |
slug | string | Yes | Node slug |
EventNodePublished
Emitted when a library node becomes published, either on create or after a visibility change.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventNodePublished | Yes | - |
id | string (nodeID) | Yes | Library node ID |
slug | string | Yes | Node slug |
EventNodeSubmittedForReview
Emitted when a library node transitions to review visibility.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventNodeSubmittedForReview | Yes | - |
id | string (nodeID) | Yes | Library node ID |
slug | string | Yes | Node slug |
EventNodeUnpublished
Emitted when a previously published library node transitions to draft, unlisted, or review.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventNodeUnpublished | Yes | - |
id | string (nodeID) | Yes | Library node ID |
slug | string | Yes | Node slug |
EventAccountCreated
Emitted after a new account is created.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventAccountCreated | Yes | - |
id | string (accountID) | Yes | Account ID |
EventAccountUpdated
Emitted after account profile, email, or role assignment changes.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventAccountUpdated | Yes | - |
id | string (accountID) | Yes | Account ID |
EventAccountSuspended
Emitted when an account is suspended.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventAccountSuspended | Yes | - |
id | string (accountID) | Yes | Account ID |
EventAccountUnsuspended
Emitted when a suspended account is reinstated.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventAccountUnsuspended | Yes | - |
id | string (accountID) | Yes | Account ID |
EventReportCreated
Emitted when a new member or system report is created.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventReportCreated | Yes | - |
id | string (reportID) | Yes | Report ID |
reported_by | string (accountID) | No | Optional account ID of reporter, not set if it was an automated system report. |
target | DatagraphRef | No | Reference to the item that was reported. |
EventReportUpdated
Emitted when a report is updated, including status and handler changes.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventReportUpdated | Yes | - |
handled_by | string (accountID) | No | Optional account ID of handler |
id | string (reportID) | Yes | Report ID |
reported_by | string (accountID) | No | Optional account ID of reporter |
status | string (reportStatus) | Yes | Report status |
target | DatagraphRef | No | Reference to the item that the report is about. |
EventActivityCreated
Emitted after an activity event is created.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventActivityCreated | Yes | - |
id | string (eventID) | Yes | Activity/Event ID |
EventActivityUpdated
Emitted after an activity event is updated.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventActivityUpdated | Yes | - |
id | string (eventID) | Yes | Activity/Event ID |
EventActivityDeleted
Emitted after an activity event is deleted.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventActivityDeleted | Yes | - |
id | string (eventID) | Yes | Activity/Event ID |
EventActivityPublished
Emitted when an activity event becomes published, either on create or after a visibility change.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventActivityPublished | Yes | - |
id | string (eventID) | Yes | Activity/Event ID |
EventSettingsUpdated
Emitted when site settings are updated via the admin settings manager.
Payload fields:
| Field | Type | Required | Description |
|---|---|---|---|
event | string, const EventSettingsUpdated | Yes | - |
settings | object | Yes | Settings object |