1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getEventRule
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

    A NetBox event rule (extras.eventrule): runs a webhook or a script when objects of the given types change.

    From the official documentation:

    NetBox can be configured via Event Rules to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the data in these webhook messages to perform related tasks. Event rules can also execute custom scripts, enabling NetBox to run defined logic locally in response to object changes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getEventRule({
        name: "test-event_rule",
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_event_rule(name="test-event_rule")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.LookupEventRule(ctx, &netbox.LookupEventRuleArgs{
    			Name: pulumi.StringRef("test-event_rule"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Netbox.GetEventRule.Invoke(new()
        {
            Name = "test-event_rule",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.NetboxFunctions;
    import com.pulumi.netbox.inputs.GetEventRuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = NetboxFunctions.getEventRule(GetEventRuleArgs.builder()
                .name("test-event_rule")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getEventRule
          arguments:
            name: test-event_rule
    
    Example coming soon!
    

    Using getEventRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEventRule(args: GetEventRuleArgs, opts?: InvokeOptions): Promise<GetEventRuleResult>
    function getEventRuleOutput(args: GetEventRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetEventRuleResult>
    def get_event_rule(action_type: Optional[str] = None,
                       custom_field_filters: Optional[Mapping[str, str]] = None,
                       enabled: Optional[bool] = None,
                       id: Optional[float] = None,
                       name: Optional[str] = None,
                       owner_id: Optional[float] = None,
                       tag_slug: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetEventRuleResult
    def get_event_rule_output(action_type: pulumi.Input[Optional[str]] = None,
                       custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                       enabled: pulumi.Input[Optional[bool]] = None,
                       id: pulumi.Input[Optional[float]] = None,
                       name: pulumi.Input[Optional[str]] = None,
                       owner_id: pulumi.Input[Optional[float]] = None,
                       tag_slug: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetEventRuleResult]
    func LookupEventRule(ctx *Context, args *LookupEventRuleArgs, opts ...InvokeOption) (*LookupEventRuleResult, error)
    func LookupEventRuleOutput(ctx *Context, args *LookupEventRuleOutputArgs, opts ...InvokeOption) LookupEventRuleResultOutput

    > Note: This function is named LookupEventRule in the Go SDK.

    public static class GetEventRule 
    {
        public static Task<GetEventRuleResult> InvokeAsync(GetEventRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetEventRuleResult> Invoke(GetEventRuleInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetEventRuleResult> Invoke(GetEventRuleInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetEventRuleResult> getEventRule(GetEventRuleArgs args, InvokeOptions options)
    public static Output<GetEventRuleResult> getEventRule(GetEventRuleArgs args, InvokeOptions options)
    public static Output<GetEventRuleResult> getEventRule(GetEventRuleArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getEventRule:getEventRule
      arguments:
        # arguments dictionary
    data "netbox_get_event_rule" "name" {
        # arguments
    }

    The following arguments are supported:

    ActionType string
    What the rule runs. One of: webhook, script, notification.
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    Enabled bool
    Whether the rule fires.
    Id double
    NetBox id.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    TagSlug string
    Slug of a tag the object carries.
    ActionType string
    What the rule runs. One of: webhook, script, notification.
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    Enabled bool
    Whether the rule fires.
    Id float64
    NetBox id.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    TagSlug string
    Slug of a tag the object carries.
    action_type string
    What the rule runs. One of: webhook, script, notification.
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    enabled bool
    Whether the rule fires.
    id number
    NetBox id.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    tag_slug string
    Slug of a tag the object carries.
    actionType String
    What the rule runs. One of: webhook, script, notification.
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    enabled Boolean
    Whether the rule fires.
    id Double
    NetBox id.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    tagSlug String
    Slug of a tag the object carries.
    actionType string
    What the rule runs. One of: webhook, script, notification.
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    enabled boolean
    Whether the rule fires.
    id number
    NetBox id.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    tagSlug string
    Slug of a tag the object carries.
    action_type str
    What the rule runs. One of: webhook, script, notification.
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    enabled bool
    Whether the rule fires.
    id float
    NetBox id.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    tag_slug str
    Slug of a tag the object carries.
    actionType String
    What the rule runs. One of: webhook, script, notification.
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    enabled Boolean
    Whether the rule fires.
    id Number
    NetBox id.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    tagSlug String
    Slug of a tag the object carries.

    getEventRule Result

    The following output properties are available:

    ActionObjectId double
    Id of the webhook or script to run.
    ActionObjectType string
    Content type of the action object: extras.webhook or extras.script.
    ActionType string
    What the rule runs. One of: webhook, script, notification.
    Conditions string
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    Created string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    Enabled bool
    Whether the rule fires.
    EventTypes List<string>
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    Id double
    NetBox id.
    LastUpdated string
    Name string
    ObjectTypes List<string>
    Object types the rule watches, as app-labelled content types (dcim.device).
    OwnerId double
    Id of the owner the object is assigned to.
    Tags List<string>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls List<string>
    Slugs of all tags on the object, including the provider's default_tags.
    Url string
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    TagSlug string
    Slug of a tag the object carries.
    ActionObjectId float64
    Id of the webhook or script to run.
    ActionObjectType string
    Content type of the action object: extras.webhook or extras.script.
    ActionType string
    What the rule runs. One of: webhook, script, notification.
    Conditions string
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    Created string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    Enabled bool
    Whether the rule fires.
    EventTypes []string
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    Id float64
    NetBox id.
    LastUpdated string
    Name string
    ObjectTypes []string
    Object types the rule watches, as app-labelled content types (dcim.device).
    OwnerId float64
    Id of the owner the object is assigned to.
    Tags []string
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls []string
    Slugs of all tags on the object, including the provider's default_tags.
    Url string
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    TagSlug string
    Slug of a tag the object carries.
    action_object_id number
    Id of the webhook or script to run.
    action_object_type string
    Content type of the action object: extras.webhook or extras.script.
    action_type string
    What the rule runs. One of: webhook, script, notification.
    conditions string
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    created string
    custom_fields map(string)
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    enabled bool
    Whether the rule fires.
    event_types list(string)
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    id number
    NetBox id.
    last_updated string
    name string
    object_types list(string)
    Object types the rule watches, as app-labelled content types (dcim.device).
    owner_id number
    Id of the owner the object is assigned to.
    tags list(string)
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls list(string)
    Slugs of all tags on the object, including the provider's default_tags.
    url string
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tag_slug string
    Slug of a tag the object carries.
    actionObjectId Double
    Id of the webhook or script to run.
    actionObjectType String
    Content type of the action object: extras.webhook or extras.script.
    actionType String
    What the rule runs. One of: webhook, script, notification.
    conditions String
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    created String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    enabled Boolean
    Whether the rule fires.
    eventTypes List<String>
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    id Double
    NetBox id.
    lastUpdated String
    name String
    objectTypes List<String>
    Object types the rule watches, as app-labelled content types (dcim.device).
    ownerId Double
    Id of the owner the object is assigned to.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    url String
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tagSlug String
    Slug of a tag the object carries.
    actionObjectId number
    Id of the webhook or script to run.
    actionObjectType string
    Content type of the action object: extras.webhook or extras.script.
    actionType string
    What the rule runs. One of: webhook, script, notification.
    conditions string
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    created string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    enabled boolean
    Whether the rule fires.
    eventTypes string[]
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    id number
    NetBox id.
    lastUpdated string
    name string
    objectTypes string[]
    Object types the rule watches, as app-labelled content types (dcim.device).
    ownerId number
    Id of the owner the object is assigned to.
    tags string[]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls string[]
    Slugs of all tags on the object, including the provider's default_tags.
    url string
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tagSlug string
    Slug of a tag the object carries.
    action_object_id float
    Id of the webhook or script to run.
    action_object_type str
    Content type of the action object: extras.webhook or extras.script.
    action_type str
    What the rule runs. One of: webhook, script, notification.
    conditions str
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    created str
    custom_fields Mapping[str, str]
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description str
    enabled bool
    Whether the rule fires.
    event_types Sequence[str]
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    id float
    NetBox id.
    last_updated str
    name str
    object_types Sequence[str]
    Object types the rule watches, as app-labelled content types (dcim.device).
    owner_id float
    Id of the owner the object is assigned to.
    tags Sequence[str]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls Sequence[str]
    Slugs of all tags on the object, including the provider's default_tags.
    url str
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tag_slug str
    Slug of a tag the object carries.
    actionObjectId Number
    Id of the webhook or script to run.
    actionObjectType String
    Content type of the action object: extras.webhook or extras.script.
    actionType String
    What the rule runs. One of: webhook, script, notification.
    conditions String
    Conditions the changed object must satisfy, as JSON text (use jsonencode()).
    created String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    enabled Boolean
    Whether the rule fires.
    eventTypes List<String>
    Events that trigger the rule: objectcreated, objectupdated, objectdeleted, jobstarted, jobcompleted, jobfailed or job_errored.
    id Number
    NetBox id.
    lastUpdated String
    name String
    objectTypes List<String>
    Object types the rule watches, as app-labelled content types (dcim.device).
    ownerId Number
    Id of the owner the object is assigned to.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    url String
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tagSlug String
    Slug of a tag the object carries.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial