diff --git a/docs/models/extras/eventrule.md b/docs/models/extras/eventrule.md index c105a2630..b48e17a1e 100644 --- a/docs/models/extras/eventrule.md +++ b/docs/models/extras/eventrule.md @@ -18,17 +18,22 @@ The type(s) of object in NetBox that will trigger the rule. If not selected, the event rule will not be processed. -### Events +### Events Types -The events which will trigger the rule. At least one event type must be selected. +The event types which will trigger the rule. At least one event type must be selected. -| Name | Description | -|------------|--------------------------------------| -| Creations | A new object has been created | -| Updates | An existing object has been modified | -| Deletions | An object has been deleted | -| Job starts | A job for an object starts | -| Job ends | A job for an object terminates | +| Name | Description | +|----------------|---------------------------------------------| +| Object created | A new object has been created | +| Object updated | An existing object has been modified | +| Object deleted | An object has been deleted | +| Job started | A background job is initiated | +| Job completed | A background job completes successfully | +| Job failed | A background job fails | +| Job errored | A background job is aborted due to an error | + +!!! tip "Custom Event Types" + The above list includes only built-in event types. NetBox plugins can also register their own custom event types. ### Conditions diff --git a/docs/plugins/development/events.md b/docs/plugins/development/event-types.md similarity index 63% rename from docs/plugins/development/events.md rename to docs/plugins/development/event-types.md index bbf9783e2..4bcdeea31 100644 --- a/docs/plugins/development/events.md +++ b/docs/plugins/development/event-types.md @@ -1,6 +1,8 @@ -# Events +# Event Types -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. +!!! info "This feature was introduced in NetBox v4.1." + +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 `EventType` class. This can be done anywhere within the plugin. An example is provided below. ```python from django.utils.translation import gettext_lazy as _ @@ -9,8 +11,8 @@ from netbox.events import EventType, EVENT_TYPE_KIND_SUCCESS EventType( name='ticket_opened', text=_('Ticket opened'), - type=EVENT_TYPE_KIND_SUCCESS + kind=EVENT_TYPE_KIND_SUCCESS ).register() ``` -::: netbox.events.Event +::: netbox.events.EventType diff --git a/mkdocs.yml b/mkdocs.yml index f1e007dc3..072c564e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -143,7 +143,7 @@ nav: - Forms: 'plugins/development/forms.md' - Filters & Filter Sets: 'plugins/development/filtersets.md' - Search: 'plugins/development/search.md' - - Events: 'plugins/development/events.md' + - Event Types: 'plugins/development/event-types.md' - Data Backends: 'plugins/development/data-backends.md' - REST API: 'plugins/development/rest-api.md' - GraphQL API: 'plugins/development/graphql-api.md'