Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. EventTransport
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.EventTransport

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";

// Create a notification transport to slack/discord
const transport = new authentik.EventTransport("transport", {
    mode: "webhook_slack",
    sendOnce: true,
    webhookUrl: "https://discord.com/....",
});
Copy
import pulumi
import pulumi_authentik as authentik

# Create a notification transport to slack/discord
transport = authentik.EventTransport("transport",
    mode="webhook_slack",
    send_once=True,
    webhook_url="https://discord.com/....")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a notification transport to slack/discord
		_, err := authentik.NewEventTransport(ctx, "transport", &authentik.EventTransportArgs{
			Mode:       pulumi.String("webhook_slack"),
			SendOnce:   pulumi.Bool(true),
			WebhookUrl: pulumi.String("https://discord.com/...."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    // Create a notification transport to slack/discord
    var transport = new Authentik.EventTransport("transport", new()
    {
        Mode = "webhook_slack",
        SendOnce = true,
        WebhookUrl = "https://discord.com/....",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.EventTransport;
import com.pulumi.authentik.EventTransportArgs;
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) {
        // Create a notification transport to slack/discord
        var transport = new EventTransport("transport", EventTransportArgs.builder()
            .mode("webhook_slack")
            .sendOnce(true)
            .webhookUrl("https://discord.com/....")
            .build());

    }
}
Copy
resources:
  # Create a notification transport to slack/discord
  transport:
    type: authentik:EventTransport
    properties:
      mode: webhook_slack
      sendOnce: true
      webhookUrl: https://discord.com/....
Copy

Create EventTransport Resource

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

Constructor syntax

new EventTransport(name: string, args: EventTransportArgs, opts?: CustomResourceOptions);
@overload
def EventTransport(resource_name: str,
                   args: EventTransportArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def EventTransport(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   mode: Optional[str] = None,
                   event_transport_id: Optional[str] = None,
                   name: Optional[str] = None,
                   send_once: Optional[bool] = None,
                   webhook_mapping: Optional[str] = None,
                   webhook_url: Optional[str] = None)
func NewEventTransport(ctx *Context, name string, args EventTransportArgs, opts ...ResourceOption) (*EventTransport, error)
public EventTransport(string name, EventTransportArgs args, CustomResourceOptions? opts = null)
public EventTransport(String name, EventTransportArgs args)
public EventTransport(String name, EventTransportArgs args, CustomResourceOptions options)

type: authentik:EventTransport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EventTransportArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EventTransportArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EventTransportArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EventTransportArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EventTransportArgs
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 eventTransportResource = new Authentik.EventTransport("eventTransportResource", new()
{
    Mode = "string",
    EventTransportId = "string",
    Name = "string",
    SendOnce = false,
    WebhookMapping = "string",
    WebhookUrl = "string",
});
Copy
example, err := authentik.NewEventTransport(ctx, "eventTransportResource", &authentik.EventTransportArgs{
	Mode:             pulumi.String("string"),
	EventTransportId: pulumi.String("string"),
	Name:             pulumi.String("string"),
	SendOnce:         pulumi.Bool(false),
	WebhookMapping:   pulumi.String("string"),
	WebhookUrl:       pulumi.String("string"),
})
Copy
var eventTransportResource = new EventTransport("eventTransportResource", EventTransportArgs.builder()
    .mode("string")
    .eventTransportId("string")
    .name("string")
    .sendOnce(false)
    .webhookMapping("string")
    .webhookUrl("string")
    .build());
Copy
event_transport_resource = authentik.EventTransport("eventTransportResource",
    mode="string",
    event_transport_id="string",
    name="string",
    send_once=False,
    webhook_mapping="string",
    webhook_url="string")
Copy
const eventTransportResource = new authentik.EventTransport("eventTransportResource", {
    mode: "string",
    eventTransportId: "string",
    name: "string",
    sendOnce: false,
    webhookMapping: "string",
    webhookUrl: "string",
});
Copy
type: authentik:EventTransport
properties:
    eventTransportId: string
    mode: string
    name: string
    sendOnce: false
    webhookMapping: string
    webhookUrl: string
Copy

EventTransport 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 EventTransport resource accepts the following input properties:

Mode This property is required. string
Allowed values: - local - webhook - webhook_slack - email
EventTransportId string
Name string
SendOnce bool
Defaults to true.
WebhookMapping string
WebhookUrl string
Mode This property is required. string
Allowed values: - local - webhook - webhook_slack - email
EventTransportId string
Name string
SendOnce bool
Defaults to true.
WebhookMapping string
WebhookUrl string
mode This property is required. String
Allowed values: - local - webhook - webhook_slack - email
eventTransportId String
name String
sendOnce Boolean
Defaults to true.
webhookMapping String
webhookUrl String
mode This property is required. string
Allowed values: - local - webhook - webhook_slack - email
eventTransportId string
name string
sendOnce boolean
Defaults to true.
webhookMapping string
webhookUrl string
mode This property is required. str
Allowed values: - local - webhook - webhook_slack - email
event_transport_id str
name str
send_once bool
Defaults to true.
webhook_mapping str
webhook_url str
mode This property is required. String
Allowed values: - local - webhook - webhook_slack - email
eventTransportId String
name String
sendOnce Boolean
Defaults to true.
webhookMapping String
webhookUrl String

Outputs

All input properties are implicitly available as output properties. Additionally, the EventTransport 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing EventTransport Resource

Get an existing EventTransport 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?: EventTransportState, opts?: CustomResourceOptions): EventTransport
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        event_transport_id: Optional[str] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        send_once: Optional[bool] = None,
        webhook_mapping: Optional[str] = None,
        webhook_url: Optional[str] = None) -> EventTransport
func GetEventTransport(ctx *Context, name string, id IDInput, state *EventTransportState, opts ...ResourceOption) (*EventTransport, error)
public static EventTransport Get(string name, Input<string> id, EventTransportState? state, CustomResourceOptions? opts = null)
public static EventTransport get(String name, Output<String> id, EventTransportState state, CustomResourceOptions options)
resources:  _:    type: authentik:EventTransport    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EventTransportId string
Mode string
Allowed values: - local - webhook - webhook_slack - email
Name string
SendOnce bool
Defaults to true.
WebhookMapping string
WebhookUrl string
EventTransportId string
Mode string
Allowed values: - local - webhook - webhook_slack - email
Name string
SendOnce bool
Defaults to true.
WebhookMapping string
WebhookUrl string
eventTransportId String
mode String
Allowed values: - local - webhook - webhook_slack - email
name String
sendOnce Boolean
Defaults to true.
webhookMapping String
webhookUrl String
eventTransportId string
mode string
Allowed values: - local - webhook - webhook_slack - email
name string
sendOnce boolean
Defaults to true.
webhookMapping string
webhookUrl string
event_transport_id str
mode str
Allowed values: - local - webhook - webhook_slack - email
name str
send_once bool
Defaults to true.
webhook_mapping str
webhook_url str
eventTransportId String
mode String
Allowed values: - local - webhook - webhook_slack - email
name String
sendOnce Boolean
Defaults to true.
webhookMapping String
webhookUrl String

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik