Skip to content

Appendix: Event Types and Configuration Reference

This chapter provides reference documentation and configuration examples to help you deeply understand opencode-notify's event types and configuration options. These contents are suitable for reference material and do not need to be learned in order.

Learning Path

1. Event Types Description

Learn about the OpenCode event types listened to by the plugin and their trigger conditions.

  • Four event types (session.idle, session.error, permission.updated, tool.execute.before)
  • Trigger timing and processing logic for each event
  • Filtering rules for parent session check, quiet hours check, and terminal focus check
  • Functional differences across platforms

2. Configuration File Example

View complete configuration file examples and detailed comments for all fields.

  • Complete configuration file template
  • Field descriptions for notifyChildSessions, sounds, quietHours, terminal, etc.
  • Complete list of macOS available sounds
  • Minimal configuration example
  • Methods to disable the plugin

Prerequisites

Learning Recommendation

This chapter is reference documentation that can be consulted when needed. We recommend referencing this chapter after completing the following basic tutorials:

Next Steps

After completing the appendix content, you can: