1. Packages
  2. Coralogix Provider
  3. API Docs
  4. getWebhook
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix.getWebhook

Explore with Pulumi AI

coralogix logo
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

    Coralogix webhook. For more info please review - https://coralogix.com/docs/coralogix-Webhook-extension/.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as coralogix from "@pulumi/coralogix";
    
    const importedWebhookById = coralogix.getWebhook({
        id: coralogix_webhook.slack_webhook.id,
    });
    const importedWebhookByName = coralogix.getWebhook({
        name: coralogix_webhook.slack_webhook.name,
    });
    
    import pulumi
    import pulumi_coralogix as coralogix
    
    imported_webhook_by_id = coralogix.get_webhook(id=coralogix_webhook["slack_webhook"]["id"])
    imported_webhook_by_name = coralogix.get_webhook(name=coralogix_webhook["slack_webhook"]["name"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/coralogix/v2/coralogix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := coralogix.LookupWebhook(ctx, &coralogix.LookupWebhookArgs{
    			Id: pulumi.StringRef(coralogix_webhook.Slack_webhook.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = coralogix.LookupWebhook(ctx, &coralogix.LookupWebhookArgs{
    			Name: pulumi.StringRef(coralogix_webhook.Slack_webhook.Name),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Coralogix = Pulumi.Coralogix;
    
    return await Deployment.RunAsync(() => 
    {
        var importedWebhookById = Coralogix.GetWebhook.Invoke(new()
        {
            Id = coralogix_webhook.Slack_webhook.Id,
        });
    
        var importedWebhookByName = Coralogix.GetWebhook.Invoke(new()
        {
            Name = coralogix_webhook.Slack_webhook.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.coralogix.CoralogixFunctions;
    import com.pulumi.coralogix.inputs.GetWebhookArgs;
    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) {
            final var importedWebhookById = CoralogixFunctions.getWebhook(GetWebhookArgs.builder()
                .id(coralogix_webhook.slack_webhook().id())
                .build());
    
            final var importedWebhookByName = CoralogixFunctions.getWebhook(GetWebhookArgs.builder()
                .name(coralogix_webhook.slack_webhook().name())
                .build());
    
        }
    }
    
    variables:
      importedWebhookById:
        fn::invoke:
          function: coralogix:getWebhook
          arguments:
            id: ${coralogix_webhook.slack_webhook.id}
      importedWebhookByName:
        fn::invoke:
          function: coralogix:getWebhook
          arguments:
            name: ${coralogix_webhook.slack_webhook.name}
    

    Using getWebhook

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebhook(args: GetWebhookArgs, opts?: InvokeOptions): Promise<GetWebhookResult>
    function getWebhookOutput(args: GetWebhookOutputArgs, opts?: InvokeOptions): Output<GetWebhookResult>
    def get_webhook(id: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWebhookResult
    def get_webhook_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWebhookResult]
    func LookupWebhook(ctx *Context, args *LookupWebhookArgs, opts ...InvokeOption) (*LookupWebhookResult, error)
    func LookupWebhookOutput(ctx *Context, args *LookupWebhookOutputArgs, opts ...InvokeOption) LookupWebhookResultOutput

    > Note: This function is named LookupWebhook in the Go SDK.

    public static class GetWebhook 
    {
        public static Task<GetWebhookResult> InvokeAsync(GetWebhookArgs args, InvokeOptions? opts = null)
        public static Output<GetWebhookResult> Invoke(GetWebhookInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
    public static Output<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
    
    fn::invoke:
      function: coralogix:index/getWebhook:getWebhook
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Webhook ID.
    Name string
    Webhook name.
    Id string
    Webhook ID.
    Name string
    Webhook name.
    id String
    Webhook ID.
    name String
    Webhook name.
    id string
    Webhook ID.
    name string
    Webhook name.
    id str
    Webhook ID.
    name str
    Webhook name.
    id String
    Webhook ID.
    name String
    Webhook name.

    getWebhook Result

    The following output properties are available:

    Custom GetWebhookCustom
    Generic webhook.
    Demisto GetWebhookDemisto
    Demisto webhook.
    EmailGroup GetWebhookEmailGroup
    Email group webhook.
    EventBridge GetWebhookEventBridge
    ExternalId string
    Webhook external ID. Using to linq webhook to alert.
    Jira GetWebhookJira
    Jira webhook.
    MicrosoftTeams GetWebhookMicrosoftTeams
    Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)
    MicrosoftTeamsWorkflow GetWebhookMicrosoftTeamsWorkflow
    Microsoft Teams Workflow webhook.
    Name string
    Webhook name.
    Opsgenie GetWebhookOpsgenie
    Opsgenie webhook.
    PagerDuty GetWebhookPagerDuty
    PagerDuty webhook.
    Sendlog GetWebhookSendlog
    Send log webhook.
    Slack GetWebhookSlack
    Slack webhook.
    Id string
    Webhook ID.
    Custom GetWebhookCustom
    Generic webhook.
    Demisto GetWebhookDemisto
    Demisto webhook.
    EmailGroup GetWebhookEmailGroup
    Email group webhook.
    EventBridge GetWebhookEventBridge
    ExternalId string
    Webhook external ID. Using to linq webhook to alert.
    Jira GetWebhookJira
    Jira webhook.
    MicrosoftTeams GetWebhookMicrosoftTeams
    Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)
    MicrosoftTeamsWorkflow GetWebhookMicrosoftTeamsWorkflow
    Microsoft Teams Workflow webhook.
    Name string
    Webhook name.
    Opsgenie GetWebhookOpsgenie
    Opsgenie webhook.
    PagerDuty GetWebhookPagerDuty
    PagerDuty webhook.
    Sendlog GetWebhookSendlog
    Send log webhook.
    Slack GetWebhookSlack
    Slack webhook.
    Id string
    Webhook ID.
    custom GetWebhookCustom
    Generic webhook.
    demisto GetWebhookDemisto
    Demisto webhook.
    emailGroup GetWebhookEmailGroup
    Email group webhook.
    eventBridge GetWebhookEventBridge
    externalId String
    Webhook external ID. Using to linq webhook to alert.
    jira GetWebhookJira
    Jira webhook.
    microsoftTeams GetWebhookMicrosoftTeams
    Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)
    microsoftTeamsWorkflow GetWebhookMicrosoftTeamsWorkflow
    Microsoft Teams Workflow webhook.
    name String
    Webhook name.
    opsgenie GetWebhookOpsgenie
    Opsgenie webhook.
    pagerDuty GetWebhookPagerDuty
    PagerDuty webhook.
    sendlog GetWebhookSendlog
    Send log webhook.
    slack GetWebhookSlack
    Slack webhook.
    id String
    Webhook ID.
    custom GetWebhookCustom
    Generic webhook.
    demisto GetWebhookDemisto
    Demisto webhook.
    emailGroup GetWebhookEmailGroup
    Email group webhook.
    eventBridge GetWebhookEventBridge
    externalId string
    Webhook external ID. Using to linq webhook to alert.
    jira GetWebhookJira
    Jira webhook.
    microsoftTeams GetWebhookMicrosoftTeams
    Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)
    microsoftTeamsWorkflow GetWebhookMicrosoftTeamsWorkflow
    Microsoft Teams Workflow webhook.
    name string
    Webhook name.
    opsgenie GetWebhookOpsgenie
    Opsgenie webhook.
    pagerDuty GetWebhookPagerDuty
    PagerDuty webhook.
    sendlog GetWebhookSendlog
    Send log webhook.
    slack GetWebhookSlack
    Slack webhook.
    id string
    Webhook ID.
    custom GetWebhookCustom
    Generic webhook.
    demisto GetWebhookDemisto
    Demisto webhook.
    email_group GetWebhookEmailGroup
    Email group webhook.
    event_bridge GetWebhookEventBridge
    external_id str
    Webhook external ID. Using to linq webhook to alert.
    jira GetWebhookJira
    Jira webhook.
    microsoft_teams GetWebhookMicrosoftTeams
    Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)
    microsoft_teams_workflow GetWebhookMicrosoftTeamsWorkflow
    Microsoft Teams Workflow webhook.
    name str
    Webhook name.
    opsgenie GetWebhookOpsgenie
    Opsgenie webhook.
    pager_duty GetWebhookPagerDuty
    PagerDuty webhook.
    sendlog GetWebhookSendlog
    Send log webhook.
    slack GetWebhookSlack
    Slack webhook.
    id str
    Webhook ID.
    custom Property Map
    Generic webhook.
    demisto Property Map
    Demisto webhook.
    emailGroup Property Map
    Email group webhook.
    eventBridge Property Map
    externalId String
    Webhook external ID. Using to linq webhook to alert.
    jira Property Map
    Jira webhook.
    microsoftTeams Property Map
    Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)
    microsoftTeamsWorkflow Property Map
    Microsoft Teams Workflow webhook.
    name String
    Webhook name.
    opsgenie Property Map
    Opsgenie webhook.
    pagerDuty Property Map
    PagerDuty webhook.
    sendlog Property Map
    Send log webhook.
    slack Property Map
    Slack webhook.
    id String
    Webhook ID.

    Supporting Types

    GetWebhookCustom

    Headers Dictionary<string, string>
    Webhook headers. Map of string to string.
    Method string
    Webhook method. can be one of: get, post, put
    Payload string
    Webhook payload. JSON string.
    Url string
    Webhook URL.
    Uuid string
    Webhook UUID. Computed automatically.
    Headers map[string]string
    Webhook headers. Map of string to string.
    Method string
    Webhook method. can be one of: get, post, put
    Payload string
    Webhook payload. JSON string.
    Url string
    Webhook URL.
    Uuid string
    Webhook UUID. Computed automatically.
    headers Map<String,String>
    Webhook headers. Map of string to string.
    method String
    Webhook method. can be one of: get, post, put
    payload String
    Webhook payload. JSON string.
    url String
    Webhook URL.
    uuid String
    Webhook UUID. Computed automatically.
    headers {[key: string]: string}
    Webhook headers. Map of string to string.
    method string
    Webhook method. can be one of: get, post, put
    payload string
    Webhook payload. JSON string.
    url string
    Webhook URL.
    uuid string
    Webhook UUID. Computed automatically.
    headers Mapping[str, str]
    Webhook headers. Map of string to string.
    method str
    Webhook method. can be one of: get, post, put
    payload str
    Webhook payload. JSON string.
    url str
    Webhook URL.
    uuid str
    Webhook UUID. Computed automatically.
    headers Map<String>
    Webhook headers. Map of string to string.
    method String
    Webhook method. can be one of: get, post, put
    payload String
    Webhook payload. JSON string.
    url String
    Webhook URL.
    uuid String
    Webhook UUID. Computed automatically.

    GetWebhookDemisto

    Payload string
    Webhook payload. JSON string.
    Url string
    Microsoft Teams URL.
    Uuid string
    Webhook UUID. Computed automatically.
    Payload string
    Webhook payload. JSON string.
    Url string
    Microsoft Teams URL.
    Uuid string
    Webhook UUID. Computed automatically.
    payload String
    Webhook payload. JSON string.
    url String
    Microsoft Teams URL.
    uuid String
    Webhook UUID. Computed automatically.
    payload string
    Webhook payload. JSON string.
    url string
    Microsoft Teams URL.
    uuid string
    Webhook UUID. Computed automatically.
    payload str
    Webhook payload. JSON string.
    url str
    Microsoft Teams URL.
    uuid str
    Webhook UUID. Computed automatically.
    payload String
    Webhook payload. JSON string.
    url String
    Microsoft Teams URL.
    uuid String
    Webhook UUID. Computed automatically.

    GetWebhookEmailGroup

    Emails List<string>
    Emails list.
    Emails []string
    Emails list.
    emails List<String>
    Emails list.
    emails string[]
    Emails list.
    emails Sequence[str]
    Emails list.
    emails List<String>
    Emails list.

    GetWebhookEventBridge

    Detail string
    Event bridge message. JSON string. More details about the token "here"
    DetailType string
    Free text to be included in the event.
    EventBusArn string
    Corresponds to the event bus, which will receive notifications. The policy attached must contain permission to publish.
    RoleName string
    Corresponds to the AWS IAM role that will be created in your account.
    Source string
    Free text is used to identify the messages Coralogix sends.
    Detail string
    Event bridge message. JSON string. More details about the token "here"
    DetailType string
    Free text to be included in the event.
    EventBusArn string
    Corresponds to the event bus, which will receive notifications. The policy attached must contain permission to publish.
    RoleName string
    Corresponds to the AWS IAM role that will be created in your account.
    Source string
    Free text is used to identify the messages Coralogix sends.
    detail String
    Event bridge message. JSON string. More details about the token "here"
    detailType String
    Free text to be included in the event.
    eventBusArn String
    Corresponds to the event bus, which will receive notifications. The policy attached must contain permission to publish.
    roleName String
    Corresponds to the AWS IAM role that will be created in your account.
    source String
    Free text is used to identify the messages Coralogix sends.
    detail string
    Event bridge message. JSON string. More details about the token "here"
    detailType string
    Free text to be included in the event.
    eventBusArn string
    Corresponds to the event bus, which will receive notifications. The policy attached must contain permission to publish.
    roleName string
    Corresponds to the AWS IAM role that will be created in your account.
    source string
    Free text is used to identify the messages Coralogix sends.
    detail str
    Event bridge message. JSON string. More details about the token "here"
    detail_type str
    Free text to be included in the event.
    event_bus_arn str
    Corresponds to the event bus, which will receive notifications. The policy attached must contain permission to publish.
    role_name str
    Corresponds to the AWS IAM role that will be created in your account.
    source str
    Free text is used to identify the messages Coralogix sends.
    detail String
    Event bridge message. JSON string. More details about the token "here"
    detailType String
    Free text to be included in the event.
    eventBusArn String
    Corresponds to the event bus, which will receive notifications. The policy attached must contain permission to publish.
    roleName String
    Corresponds to the AWS IAM role that will be created in your account.
    source String
    Free text is used to identify the messages Coralogix sends.

    GetWebhookJira

    ApiToken string
    Jira API token.
    Email string
    email.
    ProjectKey string
    Jira project key.
    Url string
    Jira URL.
    ApiToken string
    Jira API token.
    Email string
    email.
    ProjectKey string
    Jira project key.
    Url string
    Jira URL.
    apiToken String
    Jira API token.
    email String
    email.
    projectKey String
    Jira project key.
    url String
    Jira URL.
    apiToken string
    Jira API token.
    email string
    email.
    projectKey string
    Jira project key.
    url string
    Jira URL.
    api_token str
    Jira API token.
    email str
    email.
    project_key str
    Jira project key.
    url str
    Jira URL.
    apiToken String
    Jira API token.
    email String
    email.
    projectKey String
    Jira project key.
    url String
    Jira URL.

    GetWebhookMicrosoftTeams

    Url string
    Microsoft Teams URL.
    Url string
    Microsoft Teams URL.
    url String
    Microsoft Teams URL.
    url string
    Microsoft Teams URL.
    url str
    Microsoft Teams URL.
    url String
    Microsoft Teams URL.

    GetWebhookMicrosoftTeamsWorkflow

    Url string
    Microsoft Teams Workflow URL.
    Url string
    Microsoft Teams Workflow URL.
    url String
    Microsoft Teams Workflow URL.
    url string
    Microsoft Teams Workflow URL.
    url str
    Microsoft Teams Workflow URL.
    url String
    Microsoft Teams Workflow URL.

    GetWebhookOpsgenie

    Url string
    Opsgenie URL.
    Url string
    Opsgenie URL.
    url String
    Opsgenie URL.
    url string
    Opsgenie URL.
    url str
    Opsgenie URL.
    url String
    Opsgenie URL.

    GetWebhookPagerDuty

    ServiceKey string
    PagerDuty service key.
    ServiceKey string
    PagerDuty service key.
    serviceKey String
    PagerDuty service key.
    serviceKey string
    PagerDuty service key.
    service_key str
    PagerDuty service key.
    serviceKey String
    PagerDuty service key.

    GetWebhookSendlog

    Payload string
    Webhook payload. JSON string.
    Url string
    Webhook URL.
    Uuid string
    Webhook UUID. Computed automatically.
    Payload string
    Webhook payload. JSON string.
    Url string
    Webhook URL.
    Uuid string
    Webhook UUID. Computed automatically.
    payload String
    Webhook payload. JSON string.
    url String
    Webhook URL.
    uuid String
    Webhook UUID. Computed automatically.
    payload string
    Webhook payload. JSON string.
    url string
    Webhook URL.
    uuid string
    Webhook UUID. Computed automatically.
    payload str
    Webhook payload. JSON string.
    url str
    Webhook URL.
    uuid str
    Webhook UUID. Computed automatically.
    payload String
    Webhook payload. JSON string.
    url String
    Webhook URL.
    uuid String
    Webhook UUID. Computed automatically.

    GetWebhookSlack

    Attachments List<GetWebhookSlackAttachment>
    Slack attachments.
    NotifyOns List<string>
    Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
    Url string
    Slack URL.
    Attachments []GetWebhookSlackAttachment
    Slack attachments.
    NotifyOns []string
    Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
    Url string
    Slack URL.
    attachments List<GetWebhookSlackAttachment>
    Slack attachments.
    notifyOns List<String>
    Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
    url String
    Slack URL.
    attachments GetWebhookSlackAttachment[]
    Slack attachments.
    notifyOns string[]
    Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
    url string
    Slack URL.
    attachments Sequence[GetWebhookSlackAttachment]
    Slack attachments.
    notify_ons Sequence[str]
    Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
    url str
    Slack URL.
    attachments List<Property Map>
    Slack attachments.
    notifyOns List<String>
    Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
    url String
    Slack URL.

    GetWebhookSlackAttachment

    Active bool
    Determines if the attachment is active. Default is true.
    Type string
    Slack attachment type. can be one of: empty, logs, metric_snapshot
    Active bool
    Determines if the attachment is active. Default is true.
    Type string
    Slack attachment type. can be one of: empty, logs, metric_snapshot
    active Boolean
    Determines if the attachment is active. Default is true.
    type String
    Slack attachment type. can be one of: empty, logs, metric_snapshot
    active boolean
    Determines if the attachment is active. Default is true.
    type string
    Slack attachment type. can be one of: empty, logs, metric_snapshot
    active bool
    Determines if the attachment is active. Default is true.
    type str
    Slack attachment type. can be one of: empty, logs, metric_snapshot
    active Boolean
    Determines if the attachment is active. Default is true.
    type String
    Slack attachment type. can be one of: empty, logs, metric_snapshot

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix