Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

EventHook

Creates an event hook.

This resource allows you to create and configure an event hook.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.EventHook("example", new Okta.EventHookArgs
        {
            Auth = 
            {
                { "key", "Authorization" },
                { "type", "HEADER" },
                { "value", "123" },
            },
            Channel = 
            {
                { "type", "HTTP" },
                { "uri", "https://example.com/test" },
                { "version", "1.0.0" },
            },
            Events = 
            {
                "user.lifecycle.create",
                "user.lifecycle.delete.initiated",
            },
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-okta/sdk/v2/go/okta"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := okta.NewEventHook(ctx, "example", &okta.EventHookArgs{
            Auth: pulumi.StringMap{
                "key":   pulumi.String("Authorization"),
                "type":  pulumi.String("HEADER"),
                "value": pulumi.String("123"),
            },
            Channel: pulumi.StringMap{
                "type":    pulumi.String("HTTP"),
                "uri":     pulumi.String("https://example.com/test"),
                "version": pulumi.String("1.0.0"),
            },
            Events: pulumi.StringArray{
                pulumi.String("user.lifecycle.create"),
                pulumi.String("user.lifecycle.delete.initiated"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_okta as okta

example = okta.EventHook("example",
    auth={
        "key": "Authorization",
        "type": "HEADER",
        "value": "123",
    },
    channel={
        "type": "HTTP",
        "uri": "https://example.com/test",
        "version": "1.0.0",
    },
    events=[
        "user.lifecycle.create",
        "user.lifecycle.delete.initiated",
    ])
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.EventHook("example", {
    auth: {
        key: "Authorization",
        type: "HEADER",
        value: "123",
    },
    channel: {
        type: "HTTP",
        uri: "https://example.com/test",
        version: "1.0.0",
    },
    events: [
        "user.lifecycle.create",
        "user.lifecycle.delete.initiated",
    ],
});

Create a EventHook Resource

new EventHook(name: string, args: EventHookArgs, opts?: CustomResourceOptions);
def EventHook(resource_name: str, opts: Optional[ResourceOptions] = None, auth: Optional[Mapping[str, str]] = None, channel: Optional[Mapping[str, str]] = None, events: Optional[Sequence[str]] = None, headers: Optional[Sequence[EventHookHeaderArgs]] = None, name: Optional[str] = None, status: Optional[str] = None)
func NewEventHook(ctx *Context, name string, args EventHookArgs, opts ...ResourceOption) (*EventHook, error)
public EventHook(string name, EventHookArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args EventHookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EventHookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EventHookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

EventHook Resource Properties

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

Inputs

The EventHook resource accepts the following input properties:

Channel Dictionary<string, string>

Details of the endpoint the event hook will hit.

Events List<string>

The events that will be delivered to this hook. See here for a list of supported events.

Auth Dictionary<string, string>

Authentication required for event hook request.

Headers List<EventHookHeaderArgs>

Map of headers to send along in event hook request.

Name string

The event hook display name.

Status string
Channel map[string]string

Details of the endpoint the event hook will hit.

Events []string

The events that will be delivered to this hook. See here for a list of supported events.

Auth map[string]string

Authentication required for event hook request.

Headers []EventHookHeader

Map of headers to send along in event hook request.

Name string

The event hook display name.

Status string
channel {[key: string]: string}

Details of the endpoint the event hook will hit.

events string[]

The events that will be delivered to this hook. See here for a list of supported events.

auth {[key: string]: string}

Authentication required for event hook request.

headers EventHookHeader[]

Map of headers to send along in event hook request.

name string

The event hook display name.

status string
channel Mapping[str, str]

Details of the endpoint the event hook will hit.

events Sequence[str]

The events that will be delivered to this hook. See here for a list of supported events.

auth Mapping[str, str]

Authentication required for event hook request.

headers Sequence[EventHookHeaderArgs]

Map of headers to send along in event hook request.

name str

The event hook display name.

status str

Outputs

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

Look up an Existing EventHook Resource

Get an existing EventHook 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?: EventHookState, opts?: CustomResourceOptions): EventHook
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, auth: Optional[Mapping[str, str]] = None, channel: Optional[Mapping[str, str]] = None, events: Optional[Sequence[str]] = None, headers: Optional[Sequence[EventHookHeaderArgs]] = None, name: Optional[str] = None, status: Optional[str] = None) -> EventHook
func GetEventHook(ctx *Context, name string, id IDInput, state *EventHookState, opts ...ResourceOption) (*EventHook, error)
public static EventHook Get(string name, Input<string> id, EventHookState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Auth Dictionary<string, string>

Authentication required for event hook request.

Channel Dictionary<string, string>

Details of the endpoint the event hook will hit.

Events List<string>

The events that will be delivered to this hook. See here for a list of supported events.

Headers List<EventHookHeaderArgs>

Map of headers to send along in event hook request.

Name string

The event hook display name.

Status string
Auth map[string]string

Authentication required for event hook request.

Channel map[string]string

Details of the endpoint the event hook will hit.

Events []string

The events that will be delivered to this hook. See here for a list of supported events.

Headers []EventHookHeader

Map of headers to send along in event hook request.

Name string

The event hook display name.

Status string
auth {[key: string]: string}

Authentication required for event hook request.

channel {[key: string]: string}

Details of the endpoint the event hook will hit.

events string[]

The events that will be delivered to this hook. See here for a list of supported events.

headers EventHookHeader[]

Map of headers to send along in event hook request.

name string

The event hook display name.

status string
auth Mapping[str, str]

Authentication required for event hook request.

channel Mapping[str, str]

Details of the endpoint the event hook will hit.

events Sequence[str]

The events that will be delivered to this hook. See here for a list of supported events.

headers Sequence[EventHookHeaderArgs]

Map of headers to send along in event hook request.

name str

The event hook display name.

status str

Supporting Types

EventHookHeader

Key string

Key to use for authentication, usually the header name, for example "Authorization".

Value string

Authentication secret.

Key string

Key to use for authentication, usually the header name, for example "Authorization".

Value string

Authentication secret.

key string

Key to use for authentication, usually the header name, for example "Authorization".

value string

Authentication secret.

key str

Key to use for authentication, usually the header name, for example "Authorization".

value str

Authentication secret.

Import

An event hook can be imported via the Okta ID.

 $ pulumi import okta:index/eventHook:EventHook example <hook id>

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.