{"id": "plugin_hooks:plugin-hook-register-events", "page": "plugin_hooks", "ref": "plugin-hook-register-events", "title": "register_events(datasette)", "content": "datasette  -  Datasette class \n                         \n                             You can use this to access plugin configuration options via  datasette.plugin_config(your_plugin_name) . \n                         \n                     \n                 \n                 This hook should return a list of  Event  subclasses that represent custom events that the plugin might send to the  datasette.track_event()  method. \n                 This example registers event subclasses for  ban-user  and  unban-user  events: \n                 from dataclasses import dataclass\nfrom datasette import hookimpl, Event\n\n\n@dataclass\nclass BanUserEvent(Event):\n    name = \"ban-user\"\n    user: dict\n\n\n@dataclass\nclass UnbanUserEvent(Event):\n    name = \"unban-user\"\n    user: dict\n\n\n@hookimpl\ndef register_events():\n    return [BanUserEvent, UnbanUserEvent] \n                 The plugin can then call  datasette.track_event(...)  to send a  ban-user  event: \n                 await datasette.track_event(\n    BanUserEvent(user={\"id\": 1, \"username\": \"cleverbot\"})\n)", "breadcrumbs": "[\"Plugin hooks\", \"Event tracking\"]", "references": "[]"}