import * as pulumi from "@pulumi/pulumi"; /** * This resource manages Org Webhooks. * * A Webhook is a configuration that allows real-time events and data from the Org to be pushed to a provided url.\ * It enables the collection of information about various topics such as device events, alarms, and audits updates at the org level.\ * The Webhook can be set up and customized using the Mist API, allowing users to receive and analyze specific data from a particular site. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as junipermist from "@pulumi/juniper-mist"; * * const webhookOne = new junipermist.org.Webhook("webhook_one", { * siteId: terraformTest.id, * name: "webhook_one", * type: "http-post", * url: "https://myserver.com:4321/", * verifyCert: false, * enabled: true, * topics: [ * "device-events", * "alarms", * "audits", * "client-join", * "client-info", * "client-sessions", * "device-updowns", * "mxedge-events", * "nac-events", * "nac-accounting", * ], * }); * ``` * * ## Import * * Using `pulumi import`, import `junipermist.org.Webhook` with: * Org Webhook can be imported by specifying the orgId and the webhookId * * ```sh * $ pulumi import junipermist:org/webhook:Webhook webhook_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309 * ``` */ export declare class Webhook extends pulumi.CustomResource { /** * Get an existing Webhook resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: WebhookState, opts?: pulumi.CustomResourceOptions): Webhook; /** * Returns true if the given object is an instance of Webhook. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Webhook; /** * Whether webhook is enabled */ readonly enabled: pulumi.Output; /** * If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000 */ readonly headers: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Display name of the webhook */ readonly name: pulumi.Output; /** * Required when `oauth2GrantType`==`clientCredentials`; OAuth2 client identifier used to request an access token */ readonly oauth2ClientId: pulumi.Output; /** * Required when `oauth2GrantType`==`clientCredentials`; OAuth2 client secret used to request an access token */ readonly oauth2ClientSecret: pulumi.Output; /** * OAuth2 grant type used when `type`==`oauth2` */ readonly oauth2GrantType: pulumi.Output; /** * Required when `oauth2GrantType`==`password`; password used for the OAuth2 token request */ readonly oauth2Password: pulumi.Output; /** * OAuth2 scopes included in the token request when `type`==`oauth2` */ readonly oauth2Scopes: pulumi.Output; /** * Required when `type`==`oauth2`; token endpoint URL used to obtain the OAuth2 access token */ readonly oauth2TokenUrl: pulumi.Output; /** * Required when `oauth2GrantType`==`password`; username used for the OAuth2 token request */ readonly oauth2Username: pulumi.Output; /** * Organization that owns the webhook */ readonly orgId: pulumi.Output; /** * Only if `type`=`http-post` */ readonly secret: pulumi.Output; /** * Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see List Webhook Topics) */ readonly singleEventPerMessage: pulumi.Output; /** * Required if `type`=`splunk`. If splunkToken is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it. */ readonly splunkToken: pulumi.Output; /** * enum: `alarms`, `audits`, `client-info`, `client-join`, `client-sessions`, `device-events`, `device-updowns`, `guest-authorizations`, `mxedge-events`, `minis-application`, `minis-reachability`, `nac-accounting`, `nac-events` */ readonly topics: pulumi.Output; /** * Delivery mechanism used by this webhook */ readonly type: pulumi.Output; /** * Destination URL that receives webhook deliveries */ readonly url: pulumi.Output; /** * When url uses HTTPS, whether to verify the certificate */ readonly verifyCert: pulumi.Output; /** * Create a Webhook resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: WebhookArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Webhook resources. */ export interface WebhookState { /** * Whether webhook is enabled */ enabled?: pulumi.Input; /** * If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000 */ headers?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Display name of the webhook */ name?: pulumi.Input; /** * Required when `oauth2GrantType`==`clientCredentials`; OAuth2 client identifier used to request an access token */ oauth2ClientId?: pulumi.Input; /** * Required when `oauth2GrantType`==`clientCredentials`; OAuth2 client secret used to request an access token */ oauth2ClientSecret?: pulumi.Input; /** * OAuth2 grant type used when `type`==`oauth2` */ oauth2GrantType?: pulumi.Input; /** * Required when `oauth2GrantType`==`password`; password used for the OAuth2 token request */ oauth2Password?: pulumi.Input; /** * OAuth2 scopes included in the token request when `type`==`oauth2` */ oauth2Scopes?: pulumi.Input[] | undefined>; /** * Required when `type`==`oauth2`; token endpoint URL used to obtain the OAuth2 access token */ oauth2TokenUrl?: pulumi.Input; /** * Required when `oauth2GrantType`==`password`; username used for the OAuth2 token request */ oauth2Username?: pulumi.Input; /** * Organization that owns the webhook */ orgId?: pulumi.Input; /** * Only if `type`=`http-post` */ secret?: pulumi.Input; /** * Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see List Webhook Topics) */ singleEventPerMessage?: pulumi.Input; /** * Required if `type`=`splunk`. If splunkToken is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it. */ splunkToken?: pulumi.Input; /** * enum: `alarms`, `audits`, `client-info`, `client-join`, `client-sessions`, `device-events`, `device-updowns`, `guest-authorizations`, `mxedge-events`, `minis-application`, `minis-reachability`, `nac-accounting`, `nac-events` */ topics?: pulumi.Input[] | undefined>; /** * Delivery mechanism used by this webhook */ type?: pulumi.Input; /** * Destination URL that receives webhook deliveries */ url?: pulumi.Input; /** * When url uses HTTPS, whether to verify the certificate */ verifyCert?: pulumi.Input; } /** * The set of arguments for constructing a Webhook resource. */ export interface WebhookArgs { /** * Whether webhook is enabled */ enabled?: pulumi.Input; /** * If `type`=`http-post`, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000 */ headers?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Display name of the webhook */ name?: pulumi.Input; /** * Required when `oauth2GrantType`==`clientCredentials`; OAuth2 client identifier used to request an access token */ oauth2ClientId?: pulumi.Input; /** * Required when `oauth2GrantType`==`clientCredentials`; OAuth2 client secret used to request an access token */ oauth2ClientSecret?: pulumi.Input; /** * OAuth2 grant type used when `type`==`oauth2` */ oauth2GrantType?: pulumi.Input; /** * Required when `oauth2GrantType`==`password`; password used for the OAuth2 token request */ oauth2Password?: pulumi.Input; /** * OAuth2 scopes included in the token request when `type`==`oauth2` */ oauth2Scopes?: pulumi.Input[] | undefined>; /** * Required when `type`==`oauth2`; token endpoint URL used to obtain the OAuth2 access token */ oauth2TokenUrl?: pulumi.Input; /** * Required when `oauth2GrantType`==`password`; username used for the OAuth2 token request */ oauth2Username?: pulumi.Input; /** * Organization that owns the webhook */ orgId: pulumi.Input; /** * Only if `type`=`http-post` */ secret?: pulumi.Input; /** * Some solutions may not be able to parse multiple events from a single message (e.g. IBM Qradar, DSM). When set to `true`, only a single event will be sent per message. this feature is only available on certain topics (see List Webhook Topics) */ singleEventPerMessage?: pulumi.Input; /** * Required if `type`=`splunk`. If splunkToken is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it. */ splunkToken?: pulumi.Input; /** * enum: `alarms`, `audits`, `client-info`, `client-join`, `client-sessions`, `device-events`, `device-updowns`, `guest-authorizations`, `mxedge-events`, `minis-application`, `minis-reachability`, `nac-accounting`, `nac-events` */ topics: pulumi.Input[]>; /** * Delivery mechanism used by this webhook */ type?: pulumi.Input; /** * Destination URL that receives webhook deliveries */ url: pulumi.Input; /** * When url uses HTTPS, whether to verify the certificate */ verifyCert?: pulumi.Input; } //# sourceMappingURL=webhook.d.ts.map