1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. EventForwarderWebhook
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

    Event Forwarder Webhook resource

    Create EventForwarderWebhook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EventForwarderWebhook(name: string, args?: EventForwarderWebhookArgs, opts?: CustomResourceOptions);
    @overload
    def EventForwarderWebhook(resource_name: str,
                              args: Optional[EventForwarderWebhookArgs] = None,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def EventForwarderWebhook(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              auth_methods_event_source_locations: Optional[Sequence[str]] = None,
                              auth_token: Optional[str] = None,
                              auth_type: Optional[str] = None,
                              client_cert_data: Optional[str] = None,
                              description: Optional[str] = None,
                              enable: Optional[str] = None,
                              event_forwarder_webhook_id: Optional[str] = None,
                              event_types: Optional[Sequence[str]] = None,
                              every: Optional[str] = None,
                              gateways_event_source_locations: Optional[Sequence[str]] = None,
                              items_event_source_locations: Optional[Sequence[str]] = None,
                              keep_prev_version: Optional[str] = None,
                              key: Optional[str] = None,
                              name: Optional[str] = None,
                              password: Optional[str] = None,
                              private_key_data: Optional[str] = None,
                              runner_type: Optional[str] = None,
                              server_certificates: Optional[str] = None,
                              targets_event_source_locations: Optional[Sequence[str]] = None,
                              url: Optional[str] = None,
                              username: Optional[str] = None)
    func NewEventForwarderWebhook(ctx *Context, name string, args *EventForwarderWebhookArgs, opts ...ResourceOption) (*EventForwarderWebhook, error)
    public EventForwarderWebhook(string name, EventForwarderWebhookArgs? args = null, CustomResourceOptions? opts = null)
    public EventForwarderWebhook(String name, EventForwarderWebhookArgs args)
    public EventForwarderWebhook(String name, EventForwarderWebhookArgs args, CustomResourceOptions options)
    
    type: akeyless:EventForwarderWebhook
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_eventforwarderwebhook" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EventForwarderWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EventForwarderWebhookArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EventForwarderWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventForwarderWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventForwarderWebhookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var eventForwarderWebhookResource = new Akeyless.EventForwarderWebhook("eventForwarderWebhookResource", new()
    {
        AuthMethodsEventSourceLocations = new[]
        {
            "string",
        },
        AuthToken = "string",
        AuthType = "string",
        ClientCertData = "string",
        Description = "string",
        Enable = "string",
        EventForwarderWebhookId = "string",
        EventTypes = new[]
        {
            "string",
        },
        Every = "string",
        GatewaysEventSourceLocations = new[]
        {
            "string",
        },
        ItemsEventSourceLocations = new[]
        {
            "string",
        },
        KeepPrevVersion = "string",
        Key = "string",
        Name = "string",
        Password = "string",
        PrivateKeyData = "string",
        RunnerType = "string",
        ServerCertificates = "string",
        TargetsEventSourceLocations = new[]
        {
            "string",
        },
        Url = "string",
        Username = "string",
    });
    
    example, err := akeyless.NewEventForwarderWebhook(ctx, "eventForwarderWebhookResource", &akeyless.EventForwarderWebhookArgs{
    	AuthMethodsEventSourceLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuthToken:               pulumi.String("string"),
    	AuthType:                pulumi.String("string"),
    	ClientCertData:          pulumi.String("string"),
    	Description:             pulumi.String("string"),
    	Enable:                  pulumi.String("string"),
    	EventForwarderWebhookId: pulumi.String("string"),
    	EventTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Every: pulumi.String("string"),
    	GatewaysEventSourceLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ItemsEventSourceLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	KeepPrevVersion:    pulumi.String("string"),
    	Key:                pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Password:           pulumi.String("string"),
    	PrivateKeyData:     pulumi.String("string"),
    	RunnerType:         pulumi.String("string"),
    	ServerCertificates: pulumi.String("string"),
    	TargetsEventSourceLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Url:      pulumi.String("string"),
    	Username: pulumi.String("string"),
    })
    
    resource "akeyless_eventforwarderwebhook" "eventForwarderWebhookResource" {
      auth_methods_event_source_locations = ["string"]
      auth_token                          = "string"
      auth_type                           = "string"
      client_cert_data                    = "string"
      description                         = "string"
      enable                              = "string"
      event_forwarder_webhook_id          = "string"
      event_types                         = ["string"]
      every                               = "string"
      gateways_event_source_locations     = ["string"]
      items_event_source_locations        = ["string"]
      keep_prev_version                   = "string"
      key                                 = "string"
      name                                = "string"
      password                            = "string"
      private_key_data                    = "string"
      runner_type                         = "string"
      server_certificates                 = "string"
      targets_event_source_locations      = ["string"]
      url                                 = "string"
      username                            = "string"
    }
    
    var eventForwarderWebhookResource = new EventForwarderWebhook("eventForwarderWebhookResource", EventForwarderWebhookArgs.builder()
        .authMethodsEventSourceLocations("string")
        .authToken("string")
        .authType("string")
        .clientCertData("string")
        .description("string")
        .enable("string")
        .eventForwarderWebhookId("string")
        .eventTypes("string")
        .every("string")
        .gatewaysEventSourceLocations("string")
        .itemsEventSourceLocations("string")
        .keepPrevVersion("string")
        .key("string")
        .name("string")
        .password("string")
        .privateKeyData("string")
        .runnerType("string")
        .serverCertificates("string")
        .targetsEventSourceLocations("string")
        .url("string")
        .username("string")
        .build());
    
    event_forwarder_webhook_resource = akeyless.EventForwarderWebhook("eventForwarderWebhookResource",
        auth_methods_event_source_locations=["string"],
        auth_token="string",
        auth_type="string",
        client_cert_data="string",
        description="string",
        enable="string",
        event_forwarder_webhook_id="string",
        event_types=["string"],
        every="string",
        gateways_event_source_locations=["string"],
        items_event_source_locations=["string"],
        keep_prev_version="string",
        key="string",
        name="string",
        password="string",
        private_key_data="string",
        runner_type="string",
        server_certificates="string",
        targets_event_source_locations=["string"],
        url="string",
        username="string")
    
    const eventForwarderWebhookResource = new akeyless.EventForwarderWebhook("eventForwarderWebhookResource", {
        authMethodsEventSourceLocations: ["string"],
        authToken: "string",
        authType: "string",
        clientCertData: "string",
        description: "string",
        enable: "string",
        eventForwarderWebhookId: "string",
        eventTypes: ["string"],
        every: "string",
        gatewaysEventSourceLocations: ["string"],
        itemsEventSourceLocations: ["string"],
        keepPrevVersion: "string",
        key: "string",
        name: "string",
        password: "string",
        privateKeyData: "string",
        runnerType: "string",
        serverCertificates: "string",
        targetsEventSourceLocations: ["string"],
        url: "string",
        username: "string",
    });
    
    type: akeyless:EventForwarderWebhook
    properties:
        authMethodsEventSourceLocations:
            - string
        authToken: string
        authType: string
        clientCertData: string
        description: string
        enable: string
        eventForwarderWebhookId: string
        eventTypes:
            - string
        every: string
        gatewaysEventSourceLocations:
            - string
        itemsEventSourceLocations:
            - string
        keepPrevVersion: string
        key: string
        name: string
        password: string
        privateKeyData: string
        runnerType: string
        serverCertificates: string
        targetsEventSourceLocations:
            - string
        url: string
        username: string
    

    EventForwarderWebhook Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EventForwarderWebhook resource accepts the following input properties:

    AuthMethodsEventSourceLocations List<string>
    Auth Methods event sources to forward events about, for example: /abc/*
    AuthToken string
    Base64 encoded Token string for authentication type Token
    AuthType string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    ClientCertData string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    Description string
    Description of the object
    Enable string
    Enable/Disable Event Forwarder [true/false]
    EventForwarderWebhookId string
    The ID of this resource.
    EventTypes List<string>
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations List<string>
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    ItemsEventSourceLocations List<string>
    Items event sources to forward events about, for example: /abc/*
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    Name string
    Event Forwarder name
    Password string
    Password for authentication relevant for user-pass auth-type
    PrivateKeyData string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    ServerCertificates string
    Base64 encoded PEM certificate of the Webhook
    TargetsEventSourceLocations List<string>
    Targets event sources to forward events about, for example: /abc/*
    Url string
    Webhook URL
    Username string
    Username for authentication relevant for user-pass auth-type
    AuthMethodsEventSourceLocations []string
    Auth Methods event sources to forward events about, for example: /abc/*
    AuthToken string
    Base64 encoded Token string for authentication type Token
    AuthType string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    ClientCertData string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    Description string
    Description of the object
    Enable string
    Enable/Disable Event Forwarder [true/false]
    EventForwarderWebhookId string
    The ID of this resource.
    EventTypes []string
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations []string
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    ItemsEventSourceLocations []string
    Items event sources to forward events about, for example: /abc/*
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    Name string
    Event Forwarder name
    Password string
    Password for authentication relevant for user-pass auth-type
    PrivateKeyData string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    ServerCertificates string
    Base64 encoded PEM certificate of the Webhook
    TargetsEventSourceLocations []string
    Targets event sources to forward events about, for example: /abc/*
    Url string
    Webhook URL
    Username string
    Username for authentication relevant for user-pass auth-type
    auth_methods_event_source_locations list(string)
    Auth Methods event sources to forward events about, for example: /abc/*
    auth_token string
    Base64 encoded Token string for authentication type Token
    auth_type string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    client_cert_data string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description string
    Description of the object
    enable string
    Enable/Disable Event Forwarder [true/false]
    event_forwarder_webhook_id string
    The ID of this resource.
    event_types list(string)
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every string
    Rate of periodic runner repetition in hours
    gateways_event_source_locations list(string)
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    items_event_source_locations list(string)
    Items event sources to forward events about, for example: /abc/*
    keep_prev_version string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name string
    Event Forwarder name
    password string
    Password for authentication relevant for user-pass auth-type
    private_key_data string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runner_type string
    Event Forwarder runner type [immediate/periodic]
    server_certificates string
    Base64 encoded PEM certificate of the Webhook
    targets_event_source_locations list(string)
    Targets event sources to forward events about, for example: /abc/*
    url string
    Webhook URL
    username string
    Username for authentication relevant for user-pass auth-type
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    authToken String
    Base64 encoded Token string for authentication type Token
    authType String
    The Webhook authentication type [user-pass, bearer-token, certificate]
    clientCertData String
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description String
    Description of the object
    enable String
    Enable/Disable Event Forwarder [true/false]
    eventForwarderWebhookId String
    The ID of this resource.
    eventTypes List<String>
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name String
    Event Forwarder name
    password String
    Password for authentication relevant for user-pass auth-type
    privateKeyData String
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    serverCertificates String
    Base64 encoded PEM certificate of the Webhook
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*
    url String
    Webhook URL
    username String
    Username for authentication relevant for user-pass auth-type
    authMethodsEventSourceLocations string[]
    Auth Methods event sources to forward events about, for example: /abc/*
    authToken string
    Base64 encoded Token string for authentication type Token
    authType string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    clientCertData string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description string
    Description of the object
    enable string
    Enable/Disable Event Forwarder [true/false]
    eventForwarderWebhookId string
    The ID of this resource.
    eventTypes string[]
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every string
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations string[]
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    itemsEventSourceLocations string[]
    Items event sources to forward events about, for example: /abc/*
    keepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name string
    Event Forwarder name
    password string
    Password for authentication relevant for user-pass auth-type
    privateKeyData string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runnerType string
    Event Forwarder runner type [immediate/periodic]
    serverCertificates string
    Base64 encoded PEM certificate of the Webhook
    targetsEventSourceLocations string[]
    Targets event sources to forward events about, for example: /abc/*
    url string
    Webhook URL
    username string
    Username for authentication relevant for user-pass auth-type
    auth_methods_event_source_locations Sequence[str]
    Auth Methods event sources to forward events about, for example: /abc/*
    auth_token str
    Base64 encoded Token string for authentication type Token
    auth_type str
    The Webhook authentication type [user-pass, bearer-token, certificate]
    client_cert_data str
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description str
    Description of the object
    enable str
    Enable/Disable Event Forwarder [true/false]
    event_forwarder_webhook_id str
    The ID of this resource.
    event_types Sequence[str]
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every str
    Rate of periodic runner repetition in hours
    gateways_event_source_locations Sequence[str]
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    items_event_source_locations Sequence[str]
    Items event sources to forward events about, for example: /abc/*
    keep_prev_version str
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key str
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name str
    Event Forwarder name
    password str
    Password for authentication relevant for user-pass auth-type
    private_key_data str
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runner_type str
    Event Forwarder runner type [immediate/periodic]
    server_certificates str
    Base64 encoded PEM certificate of the Webhook
    targets_event_source_locations Sequence[str]
    Targets event sources to forward events about, for example: /abc/*
    url str
    Webhook URL
    username str
    Username for authentication relevant for user-pass auth-type
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    authToken String
    Base64 encoded Token string for authentication type Token
    authType String
    The Webhook authentication type [user-pass, bearer-token, certificate]
    clientCertData String
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description String
    Description of the object
    enable String
    Enable/Disable Event Forwarder [true/false]
    eventForwarderWebhookId String
    The ID of this resource.
    eventTypes List<String>
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name String
    Event Forwarder name
    password String
    Password for authentication relevant for user-pass auth-type
    privateKeyData String
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    serverCertificates String
    Base64 encoded PEM certificate of the Webhook
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*
    url String
    Webhook URL
    username String
    Username for authentication relevant for user-pass auth-type

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventForwarderWebhook resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EventForwarderWebhook Resource

    Get an existing EventForwarderWebhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EventForwarderWebhookState, opts?: CustomResourceOptions): EventForwarderWebhook
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth_methods_event_source_locations: Optional[Sequence[str]] = None,
            auth_token: Optional[str] = None,
            auth_type: Optional[str] = None,
            client_cert_data: Optional[str] = None,
            description: Optional[str] = None,
            enable: Optional[str] = None,
            event_forwarder_webhook_id: Optional[str] = None,
            event_types: Optional[Sequence[str]] = None,
            every: Optional[str] = None,
            gateways_event_source_locations: Optional[Sequence[str]] = None,
            items_event_source_locations: Optional[Sequence[str]] = None,
            keep_prev_version: Optional[str] = None,
            key: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            private_key_data: Optional[str] = None,
            runner_type: Optional[str] = None,
            server_certificates: Optional[str] = None,
            targets_event_source_locations: Optional[Sequence[str]] = None,
            url: Optional[str] = None,
            username: Optional[str] = None) -> EventForwarderWebhook
    func GetEventForwarderWebhook(ctx *Context, name string, id IDInput, state *EventForwarderWebhookState, opts ...ResourceOption) (*EventForwarderWebhook, error)
    public static EventForwarderWebhook Get(string name, Input<string> id, EventForwarderWebhookState? state, CustomResourceOptions? opts = null)
    public static EventForwarderWebhook get(String name, Output<String> id, EventForwarderWebhookState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:EventForwarderWebhook    get:      id: ${id}
    import {
      to = akeyless_eventforwarderwebhook.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthMethodsEventSourceLocations List<string>
    Auth Methods event sources to forward events about, for example: /abc/*
    AuthToken string
    Base64 encoded Token string for authentication type Token
    AuthType string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    ClientCertData string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    Description string
    Description of the object
    Enable string
    Enable/Disable Event Forwarder [true/false]
    EventForwarderWebhookId string
    The ID of this resource.
    EventTypes List<string>
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations List<string>
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    ItemsEventSourceLocations List<string>
    Items event sources to forward events about, for example: /abc/*
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    Name string
    Event Forwarder name
    Password string
    Password for authentication relevant for user-pass auth-type
    PrivateKeyData string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    ServerCertificates string
    Base64 encoded PEM certificate of the Webhook
    TargetsEventSourceLocations List<string>
    Targets event sources to forward events about, for example: /abc/*
    Url string
    Webhook URL
    Username string
    Username for authentication relevant for user-pass auth-type
    AuthMethodsEventSourceLocations []string
    Auth Methods event sources to forward events about, for example: /abc/*
    AuthToken string
    Base64 encoded Token string for authentication type Token
    AuthType string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    ClientCertData string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    Description string
    Description of the object
    Enable string
    Enable/Disable Event Forwarder [true/false]
    EventForwarderWebhookId string
    The ID of this resource.
    EventTypes []string
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    Every string
    Rate of periodic runner repetition in hours
    GatewaysEventSourceLocations []string
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    ItemsEventSourceLocations []string
    Items event sources to forward events about, for example: /abc/*
    KeepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    Key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    Name string
    Event Forwarder name
    Password string
    Password for authentication relevant for user-pass auth-type
    PrivateKeyData string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    RunnerType string
    Event Forwarder runner type [immediate/periodic]
    ServerCertificates string
    Base64 encoded PEM certificate of the Webhook
    TargetsEventSourceLocations []string
    Targets event sources to forward events about, for example: /abc/*
    Url string
    Webhook URL
    Username string
    Username for authentication relevant for user-pass auth-type
    auth_methods_event_source_locations list(string)
    Auth Methods event sources to forward events about, for example: /abc/*
    auth_token string
    Base64 encoded Token string for authentication type Token
    auth_type string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    client_cert_data string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description string
    Description of the object
    enable string
    Enable/Disable Event Forwarder [true/false]
    event_forwarder_webhook_id string
    The ID of this resource.
    event_types list(string)
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every string
    Rate of periodic runner repetition in hours
    gateways_event_source_locations list(string)
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    items_event_source_locations list(string)
    Items event sources to forward events about, for example: /abc/*
    keep_prev_version string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name string
    Event Forwarder name
    password string
    Password for authentication relevant for user-pass auth-type
    private_key_data string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runner_type string
    Event Forwarder runner type [immediate/periodic]
    server_certificates string
    Base64 encoded PEM certificate of the Webhook
    targets_event_source_locations list(string)
    Targets event sources to forward events about, for example: /abc/*
    url string
    Webhook URL
    username string
    Username for authentication relevant for user-pass auth-type
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    authToken String
    Base64 encoded Token string for authentication type Token
    authType String
    The Webhook authentication type [user-pass, bearer-token, certificate]
    clientCertData String
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description String
    Description of the object
    enable String
    Enable/Disable Event Forwarder [true/false]
    eventForwarderWebhookId String
    The ID of this resource.
    eventTypes List<String>
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name String
    Event Forwarder name
    password String
    Password for authentication relevant for user-pass auth-type
    privateKeyData String
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    serverCertificates String
    Base64 encoded PEM certificate of the Webhook
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*
    url String
    Webhook URL
    username String
    Username for authentication relevant for user-pass auth-type
    authMethodsEventSourceLocations string[]
    Auth Methods event sources to forward events about, for example: /abc/*
    authToken string
    Base64 encoded Token string for authentication type Token
    authType string
    The Webhook authentication type [user-pass, bearer-token, certificate]
    clientCertData string
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description string
    Description of the object
    enable string
    Enable/Disable Event Forwarder [true/false]
    eventForwarderWebhookId string
    The ID of this resource.
    eventTypes string[]
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every string
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations string[]
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    itemsEventSourceLocations string[]
    Items event sources to forward events about, for example: /abc/*
    keepPrevVersion string
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key string
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name string
    Event Forwarder name
    password string
    Password for authentication relevant for user-pass auth-type
    privateKeyData string
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runnerType string
    Event Forwarder runner type [immediate/periodic]
    serverCertificates string
    Base64 encoded PEM certificate of the Webhook
    targetsEventSourceLocations string[]
    Targets event sources to forward events about, for example: /abc/*
    url string
    Webhook URL
    username string
    Username for authentication relevant for user-pass auth-type
    auth_methods_event_source_locations Sequence[str]
    Auth Methods event sources to forward events about, for example: /abc/*
    auth_token str
    Base64 encoded Token string for authentication type Token
    auth_type str
    The Webhook authentication type [user-pass, bearer-token, certificate]
    client_cert_data str
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description str
    Description of the object
    enable str
    Enable/Disable Event Forwarder [true/false]
    event_forwarder_webhook_id str
    The ID of this resource.
    event_types Sequence[str]
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every str
    Rate of periodic runner repetition in hours
    gateways_event_source_locations Sequence[str]
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    items_event_source_locations Sequence[str]
    Items event sources to forward events about, for example: /abc/*
    keep_prev_version str
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key str
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name str
    Event Forwarder name
    password str
    Password for authentication relevant for user-pass auth-type
    private_key_data str
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runner_type str
    Event Forwarder runner type [immediate/periodic]
    server_certificates str
    Base64 encoded PEM certificate of the Webhook
    targets_event_source_locations Sequence[str]
    Targets event sources to forward events about, for example: /abc/*
    url str
    Webhook URL
    username str
    Username for authentication relevant for user-pass auth-type
    authMethodsEventSourceLocations List<String>
    Auth Methods event sources to forward events about, for example: /abc/*
    authToken String
    Base64 encoded Token string for authentication type Token
    authType String
    The Webhook authentication type [user-pass, bearer-token, certificate]
    clientCertData String
    Base64 encoded PEM certificate, relevant for certificate auth-type
    description String
    Description of the object
    enable String
    Enable/Disable Event Forwarder [true/false]
    eventForwarderWebhookId String
    The ID of this resource.
    eventTypes List<String>
    List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, next-automatic-rotation, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated, rate-limiting, usage-report, secret-sync]
    every String
    Rate of periodic runner repetition in hours
    gatewaysEventSourceLocations List<String>
    Gateways event sources to forward events about, for example the relevant Gateways cluster urls: http://localhost:8000.
    itemsEventSourceLocations List<String>
    Items event sources to forward events about, for example: /abc/*
    keepPrevVersion String
    Whether to keep previous version [true/false]. If not set, use default according to account settings
    key String
    The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
    name String
    Event Forwarder name
    password String
    Password for authentication relevant for user-pass auth-type
    privateKeyData String
    Base64 encoded PEM RSA Private Key, relevant for certificate auth-type
    runnerType String
    Event Forwarder runner type [immediate/periodic]
    serverCertificates String
    Base64 encoded PEM certificate of the Webhook
    targetsEventSourceLocations List<String>
    Targets event sources to forward events about, for example: /abc/*
    url String
    Webhook URL
    username String
    Username for authentication relevant for user-pass auth-type

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
      Try Pulumi Cloud free. Your team will thank you.