Skip to content

docs: update list of emitted events #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2023
Merged

docs: update list of emitted events #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion extending/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ It is recommended to always add `**kwargs` to the receiver functions signature i
## List of emitted events

| Event | Mutations that can emit this event | Arguments |
| ------------------------- | ----------------------------------------------------------------- | ------------------------------------------------ |
|---------------------------|-------------------------------------------------------------------|--------------------------------------------------|
| `pre_create_work_item` | `CreateWorkItem`, `SaveWorkItem`, `StartCase`, `CompleteWorkItem` | `work_item`, `user`, `context`, `validated_data` |
| `post_create_work_item` | `CreateWorkItem`, `SaveWorkItem`, `StartCase`, `CompleteWorkItem` | `work_item`, `user`, `context` |
| `pre_complete_work_item` | `CompleteWorkItem` | `work_item`, `user`, `context` |
Expand All @@ -66,6 +66,8 @@ It is recommended to always add `**kwargs` to the receiver functions signature i
| `post_suspend_work_item` | `SuspendWorkItem` | `work_item`, `user`, `context` |
| `pre_resume_work_item` | `ResumeWorkItem` | `work_item`, `user`, `context` |
| `post_resume_work_item` | `ResumeWorkItem` | `work_item`, `user`, `context` |
| `pre_redo_work_item` | `RedoWorkItem` | `work_item`, `user`, `context` |
| `post_redo_work_item` | `RedoWorkItem` | `work_item`, `user`, `context` |
| `pre_create_case` | `SaveCase`, `StartCase` | `case`, `user`, `context`, `validated_data` |
| `post_create_case` | `SaveCase`, `StartCase` | `case`, `user`, `context` |
| `pre_complete_case` | `CompleteWorkItem` | `case`, `user`, `context` |
Expand All @@ -76,6 +78,8 @@ It is recommended to always add `**kwargs` to the receiver functions signature i
| `post_suspend_case` | `SuspendCase` | `case`, `user`, `context` |
| `pre_resume_case` | `ResumeCase` | `case`, `user`, `context` |
| `post_resume_case` | `ResumeCase` | `case`, `user`, `context` |
| `pre_reopen_case` | `ReopenCase` | `case`, `user`, `work_items`, `context` |
| `post_reopen_case` | `ReopenCase` | `case`, `user`, `work_items`, `context` |

In some cases when one mutation emits multiple events, it is important to know their respective order:

Expand Down