@natzka-oss/pulumi-netbox/webhook.d.ts

A Pulumi package for creating and managing Netbox cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * From the [official documentation](https://docs.netbox.dev/en/stable/integrations/webhooks/):
 *
 * > A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const test = new netbox.Webhook("test", {
 *     name: "test",
 *     payloadUrl: "https://example.com/webhook",
 *     bodytemplate: "Sample body",
 * });
 * ```
 */
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<pulumi.ID>, 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;
    readonly additionalHeaders: pulumi.Output<string | undefined>;
    readonly bodyTemplate: pulumi.Output<string | undefined>;
    /**
     * The complete list of official content types is available [here](https://www.iana.org/assignments/media-types/media-types.xhtml). Defaults to `application/json`.
     */
    readonly httpContentType: pulumi.Output<string | undefined>;
    /**
     * Valid values are `GET`, `POST`, `PUT`, `PATCH` and `DELETE`. Defaults to `POST`.
     */
    readonly httpMethod: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    readonly payloadUrl: pulumi.Output<string>;
    /**
     * 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 {
    additionalHeaders?: pulumi.Input<string>;
    bodyTemplate?: pulumi.Input<string>;
    /**
     * The complete list of official content types is available [here](https://www.iana.org/assignments/media-types/media-types.xhtml). Defaults to `application/json`.
     */
    httpContentType?: pulumi.Input<string>;
    /**
     * Valid values are `GET`, `POST`, `PUT`, `PATCH` and `DELETE`. Defaults to `POST`.
     */
    httpMethod?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    payloadUrl?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Webhook resource.
 */
export interface WebhookArgs {
    additionalHeaders?: pulumi.Input<string>;
    bodyTemplate?: pulumi.Input<string>;
    /**
     * The complete list of official content types is available [here](https://www.iana.org/assignments/media-types/media-types.xhtml). Defaults to `application/json`.
     */
    httpContentType?: pulumi.Input<string>;
    /**
     * Valid values are `GET`, `POST`, `PUT`, `PATCH` and `DELETE`. Defaults to `POST`.
     */
    httpMethod?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    payloadUrl: pulumi.Input<string>;
}