netbox/docs/plugins/development/events.md
2024-07-31 15:39:05 -04:00

17 lines
566 B
Markdown

# Events
Plugins can register their own custom event types for use with NetBox [event rules](../../models/extras/eventrule.md). This is accomplished by calling the `register()` method on an instance of the `Event` class. This can be done anywhere within the plugin. An example is provided below.
```python
from django.utils.translation import gettext_lazy as _
from netbox.events import EventType, EVENT_TYPE_KIND_SUCCESS
EventType(
name='ticket_opened',
text=_('Ticket opened'),
type=EVENT_TYPE_KIND_SUCCESS
).register()
```
::: netbox.events.Event