import { AlertChannel, AlertChannelProps } from './alert-channel'; import { HttpHeader } from './http-header'; import { HttpRequestMethod } from './http-request'; import { QueryParam } from './query-param'; export interface WebhookAlertChannelProps extends AlertChannelProps { /** * Friendly name to recognise the integration. */ name: string; webhookType?: string; /** * The URL where to send the webhook HTTP request. */ url: URL | string; /** * This is commonly a JSON body. You can * use {@link https://www.checklyhq.com/docs/communicate/alerts/webhooks/#using-variables | Handlebars-style template variables} * to add custom data to the template. */ template?: string; /** * Either `GET`, `POST`, `PUT`, `PATCH`, `HEAD`, `DELETE` or 'OPTIONS' just like an API check. */ method?: HttpRequestMethod; /** * Key-value elements array with the headers to send in the webhook HTTP request. */ headers?: Array; /** * Key-value elements array with the query parameters to include in the URL for the webhook HTTP request. */ queryParameters?: Array; /** * An optional value to use as the * {@link https://www.checklyhq.com/docs/alerting-and-retries/webhooks/#webhook-secrets secret for the webhook}. * * You may specify any value that meets your security criteria. */ webhookSecret?: string; } /** * Creates an Webhook Alert Channel * * @remarks * * This class make use of the Alert Channel endpoints. */ export declare class WebhookAlertChannel extends AlertChannel { name: string; webhookType?: string; url: URL | string; template?: string; method?: HttpRequestMethod; headers?: Array; queryParameters?: Array; webhookSecret?: string; /** * Constructs the Webhook Alert Channel instance * * @param logicalId unique project-scoped resource name identification * @param props Webhook alert channel configuration properties * * {@link https://www.checklyhq.com/docs/constructs/webhook-alert-channel/ Read more in the docs} */ constructor(logicalId: string, props: WebhookAlertChannelProps); describe(): string; synthesize(): any; }