Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Coralogix Provider
  3. API Docs
  4. Webhook
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix
coralogix/terraform-provider-coralogix

coralogix.Webhook

Explore with Pulumi AI

coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix
coralogix/terraform-provider-coralogix

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.coralogix.Webhook;
import com.pulumi.coralogix.WebhookArgs;
import com.pulumi.coralogix.inputs.WebhookSlackArgs;
import com.pulumi.coralogix.inputs.WebhookCustomArgs;
import com.pulumi.coralogix.inputs.WebhookPagerDutyArgs;
import com.pulumi.coralogix.inputs.WebhookEmailGroupArgs;
import com.pulumi.coralogix.inputs.WebhookMicrosoftTeamsWorkflowArgs;
import com.pulumi.coralogix.inputs.WebhookJiraArgs;
import com.pulumi.coralogix.inputs.WebhookOpsgenieArgs;
import com.pulumi.coralogix.inputs.WebhookDemistoArgs;
import com.pulumi.coralogix.inputs.WebhookSendlogArgs;
import com.pulumi.coralogix.inputs.WebhookEventBridgeArgs;
import com.pulumi.coralogix.Alert;
import com.pulumi.coralogix.AlertArgs;
import com.pulumi.coralogix.inputs.AlertTypeDefinitionArgs;
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) {
        var slackWebhook = new Webhook("slackWebhook", WebhookArgs.builder()
            .slack(WebhookSlackArgs.builder()
                .notify_on("flow_anomalies")
                .url("https://join.slack.com/example")
                .attachments(WebhookSlackAttachmentArgs.builder()
                    .type("metric_snapshot")
                    .active(true)
                    .build())
                .build())
            .build());

        var customWebhook = new Webhook("customWebhook", WebhookArgs.builder()
            .custom(WebhookCustomArgs.builder()
                .method("post")
                .headers(Map.of("Content-Type", "application/json"))
                .url("https://example-url.com/")
                .build())
            .build());

        var pagerDutyWebhook = new Webhook("pagerDutyWebhook", WebhookArgs.builder()
            .pagerDuty(WebhookPagerDutyArgs.builder()
                .service_key("service-key")
                .build())
            .build());

        var emailGroupWebhook = new Webhook("emailGroupWebhook", WebhookArgs.builder()
            .emailGroup(WebhookEmailGroupArgs.builder()
                .emails("user@example.com")
                .build())
            .build());

        var microsoftTeamsWebhook = new Webhook("microsoftTeamsWebhook", WebhookArgs.builder()
            .microsoftTeamsWorkflow(WebhookMicrosoftTeamsWorkflowArgs.builder()
                .url("https://example-url.com/")
                .build())
            .build());

        var jiraWebhook = new Webhook("jiraWebhook", WebhookArgs.builder()
            .jira(WebhookJiraArgs.builder()
                .api_token("api-token")
                .email("example@coralogix.com")
                .project_key("project-key")
                .url("https://coralogix.atlassian.net/jira/your-work")
                .build())
            .build());

        var opsgenieWebhook = new Webhook("opsgenieWebhook", WebhookArgs.builder()
            .opsgenie(WebhookOpsgenieArgs.builder()
                .url("https://example-url.com/")
                .build())
            .build());

        var demistoWebhook = new Webhook("demistoWebhook", WebhookArgs.builder()
            .demisto(WebhookDemistoArgs.builder()
                .url("https://example-url.com/")
                .build())
            .build());

        var sendlogWebhook = new Webhook("sendlogWebhook", WebhookArgs.builder()
            .sendlog(WebhookSendlogArgs.builder()
                .url("https://example-url.com/")
                .build())
            .build());

        var eventBridgeWebhook = new Webhook("eventBridgeWebhook", WebhookArgs.builder()
            .eventBridge(WebhookEventBridgeArgs.builder()
                .event_bus_arn("arn:aws:events:us-east-1:123456789012:event-bus/default")
                .detail("example_detail")
                .detail_type("example_detail_type")
                .source("example_source")
                .role_name("example_role_name")
                .build())
            .build());

        //example of how to use webhooks that was created via terraform
        var alertWithWebhook = new Alert("alertWithWebhook", AlertArgs.builder()
            .description("Example of logs_immediate alert from terraform")
            .priority("P2")
            .notificationGroup(AlertNotificationGroupArgs.builder()
                .webhooksSettings(AlertNotificationGroupWebhooksSettingArgs.builder()
                    .integrationId(slackWebhook.externalId())
                    .build())
                .build())
            .typeDefinition(AlertTypeDefinitionArgs.builder()
                .logs_immediate(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());

    }
}
Copy
resources:
  slackWebhook:
    type: coralogix:Webhook
    properties:
      slack:
        notify_on:
          - flow_anomalies
        url: https://join.slack.com/example
        attachments:
          - type: metric_snapshot
            active: true
  customWebhook:
    type: coralogix:Webhook
    properties:
      custom:
        method: post
        headers:
          Content-Type: application/json
        url: https://example-url.com/
  pagerDutyWebhook:
    type: coralogix:Webhook
    properties:
      pagerDuty:
        service_key: service-key
  emailGroupWebhook:
    type: coralogix:Webhook
    properties:
      emailGroup:
        emails:
          - user@example.com
  microsoftTeamsWebhook:
    type: coralogix:Webhook
    properties:
      microsoftTeamsWorkflow:
        url: https://example-url.com/
  jiraWebhook:
    type: coralogix:Webhook
    properties:
      jira:
        api_token: api-token
        email: example@coralogix.com
        project_key: project-key
        url: https://coralogix.atlassian.net/jira/your-work
  opsgenieWebhook:
    type: coralogix:Webhook
    properties:
      opsgenie:
        url: https://example-url.com/
  demistoWebhook:
    type: coralogix:Webhook
    properties:
      demisto:
        url: https://example-url.com/
  sendlogWebhook:
    type: coralogix:Webhook
    properties:
      sendlog:
        url: https://example-url.com/
  eventBridgeWebhook:
    type: coralogix:Webhook
    properties:
      eventBridge:
        event_bus_arn: arn:aws:events:us-east-1:123456789012:event-bus/default
        detail: example_detail
        detail_type: example_detail_type
        source: example_source
        role_name: example_role_name
  # example of how to use webhooks that was created via terraform
  alertWithWebhook:
    type: coralogix:Alert
    properties:
      description: Example of logs_immediate alert from terraform
      priority: P2
      notificationGroup:
        - webhooksSettings:
            - integrationId: ${slackWebhook.externalId}
      typeDefinition:
        logs_immediate:
          logsFilter:
            simpleFilter:
              luceneQuery: message:"error"
Copy

Create Webhook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Webhook(name: string, args?: WebhookArgs, opts?: CustomResourceOptions);
@overload
def Webhook(resource_name: str,
            args: Optional[WebhookArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            custom: Optional[WebhookCustomArgs] = None,
            demisto: Optional[WebhookDemistoArgs] = None,
            email_group: Optional[WebhookEmailGroupArgs] = None,
            event_bridge: Optional[WebhookEventBridgeArgs] = None,
            jira: Optional[WebhookJiraArgs] = None,
            microsoft_teams: Optional[WebhookMicrosoftTeamsArgs] = None,
            microsoft_teams_workflow: Optional[WebhookMicrosoftTeamsWorkflowArgs] = None,
            name: Optional[str] = None,
            opsgenie: Optional[WebhookOpsgenieArgs] = None,
            pager_duty: Optional[WebhookPagerDutyArgs] = None,
            sendlog: Optional[WebhookSendlogArgs] = None,
            slack: Optional[WebhookSlackArgs] = None)
func NewWebhook(ctx *Context, name string, args *WebhookArgs, opts ...ResourceOption) (*Webhook, error)
public Webhook(string name, WebhookArgs? args = null, CustomResourceOptions? opts = null)
public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

type: coralogix:Webhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args WebhookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WebhookArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var webhookResource = new Coralogix.Webhook("webhookResource", new()
{
    Custom = new Coralogix.Inputs.WebhookCustomArgs
    {
        Headers = 
        {
            { "string", "string" },
        },
        Method = "string",
        Payload = "string",
        Url = "string",
        Uuid = "string",
    },
    Demisto = new Coralogix.Inputs.WebhookDemistoArgs
    {
        Url = "string",
        Payload = "string",
        Uuid = "string",
    },
    EmailGroup = new Coralogix.Inputs.WebhookEmailGroupArgs
    {
        Emails = new[]
        {
            "string",
        },
    },
    EventBridge = new Coralogix.Inputs.WebhookEventBridgeArgs
    {
        Detail = "string",
        DetailType = "string",
        EventBusArn = "string",
        RoleName = "string",
        Source = "string",
    },
    Jira = new Coralogix.Inputs.WebhookJiraArgs
    {
        Url = "string",
        ApiToken = "string",
        Email = "string",
        ProjectKey = "string",
    },
    MicrosoftTeamsWorkflow = new Coralogix.Inputs.WebhookMicrosoftTeamsWorkflowArgs
    {
        Url = "string",
    },
    Name = "string",
    Opsgenie = new Coralogix.Inputs.WebhookOpsgenieArgs
    {
        Url = "string",
    },
    PagerDuty = new Coralogix.Inputs.WebhookPagerDutyArgs
    {
        ServiceKey = "string",
    },
    Sendlog = new Coralogix.Inputs.WebhookSendlogArgs
    {
        Url = "string",
        Payload = "string",
        Uuid = "string",
    },
    Slack = new Coralogix.Inputs.WebhookSlackArgs
    {
        Attachments = new[]
        {
            new Coralogix.Inputs.WebhookSlackAttachmentArgs
            {
                Type = "string",
                Active = false,
            },
        },
        NotifyOns = new[]
        {
            "string",
        },
        Url = "string",
    },
});
Copy
example, err := coralogix.NewWebhook(ctx, "webhookResource", &coralogix.WebhookArgs{
	Custom: &coralogix.WebhookCustomArgs{
		Headers: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Method:  pulumi.String("string"),
		Payload: pulumi.String("string"),
		Url:     pulumi.String("string"),
		Uuid:    pulumi.String("string"),
	},
	Demisto: &coralogix.WebhookDemistoArgs{
		Url:     pulumi.String("string"),
		Payload: pulumi.String("string"),
		Uuid:    pulumi.String("string"),
	},
	EmailGroup: &coralogix.WebhookEmailGroupArgs{
		Emails: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	EventBridge: &coralogix.WebhookEventBridgeArgs{
		Detail:      pulumi.String("string"),
		DetailType:  pulumi.String("string"),
		EventBusArn: pulumi.String("string"),
		RoleName:    pulumi.String("string"),
		Source:      pulumi.String("string"),
	},
	Jira: &coralogix.WebhookJiraArgs{
		Url:        pulumi.String("string"),
		ApiToken:   pulumi.String("string"),
		Email:      pulumi.String("string"),
		ProjectKey: pulumi.String("string"),
	},
	MicrosoftTeamsWorkflow: &coralogix.WebhookMicrosoftTeamsWorkflowArgs{
		Url: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Opsgenie: &coralogix.WebhookOpsgenieArgs{
		Url: pulumi.String("string"),
	},
	PagerDuty: &coralogix.WebhookPagerDutyArgs{
		ServiceKey: pulumi.String("string"),
	},
	Sendlog: &coralogix.WebhookSendlogArgs{
		Url:     pulumi.String("string"),
		Payload: pulumi.String("string"),
		Uuid:    pulumi.String("string"),
	},
	Slack: &coralogix.WebhookSlackArgs{
		Attachments: coralogix.WebhookSlackAttachmentArray{
			&coralogix.WebhookSlackAttachmentArgs{
				Type:   pulumi.String("string"),
				Active: pulumi.Bool(false),
			},
		},
		NotifyOns: pulumi.StringArray{
			pulumi.String("string"),
		},
		Url: pulumi.String("string"),
	},
})
Copy
var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .custom(WebhookCustomArgs.builder()
        .headers(Map.of("string", "string"))
        .method("string")
        .payload("string")
        .url("string")
        .uuid("string")
        .build())
    .demisto(WebhookDemistoArgs.builder()
        .url("string")
        .payload("string")
        .uuid("string")
        .build())
    .emailGroup(WebhookEmailGroupArgs.builder()
        .emails("string")
        .build())
    .eventBridge(WebhookEventBridgeArgs.builder()
        .detail("string")
        .detailType("string")
        .eventBusArn("string")
        .roleName("string")
        .source("string")
        .build())
    .jira(WebhookJiraArgs.builder()
        .url("string")
        .apiToken("string")
        .email("string")
        .projectKey("string")
        .build())
    .microsoftTeamsWorkflow(WebhookMicrosoftTeamsWorkflowArgs.builder()
        .url("string")
        .build())
    .name("string")
    .opsgenie(WebhookOpsgenieArgs.builder()
        .url("string")
        .build())
    .pagerDuty(WebhookPagerDutyArgs.builder()
        .serviceKey("string")
        .build())
    .sendlog(WebhookSendlogArgs.builder()
        .url("string")
        .payload("string")
        .uuid("string")
        .build())
    .slack(WebhookSlackArgs.builder()
        .attachments(WebhookSlackAttachmentArgs.builder()
            .type("string")
            .active(false)
            .build())
        .notifyOns("string")
        .url("string")
        .build())
    .build());
Copy
webhook_resource = coralogix.Webhook("webhookResource",
    custom={
        "headers": {
            "string": "string",
        },
        "method": "string",
        "payload": "string",
        "url": "string",
        "uuid": "string",
    },
    demisto={
        "url": "string",
        "payload": "string",
        "uuid": "string",
    },
    email_group={
        "emails": ["string"],
    },
    event_bridge={
        "detail": "string",
        "detail_type": "string",
        "event_bus_arn": "string",
        "role_name": "string",
        "source": "string",
    },
    jira={
        "url": "string",
        "api_token": "string",
        "email": "string",
        "project_key": "string",
    },
    microsoft_teams_workflow={
        "url": "string",
    },
    name="string",
    opsgenie={
        "url": "string",
    },
    pager_duty={
        "service_key": "string",
    },
    sendlog={
        "url": "string",
        "payload": "string",
        "uuid": "string",
    },
    slack={
        "attachments": [{
            "type": "string",
            "active": False,
        }],
        "notify_ons": ["string"],
        "url": "string",
    })
Copy
const webhookResource = new coralogix.Webhook("webhookResource", {
    custom: {
        headers: {
            string: "string",
        },
        method: "string",
        payload: "string",
        url: "string",
        uuid: "string",
    },
    demisto: {
        url: "string",
        payload: "string",
        uuid: "string",
    },
    emailGroup: {
        emails: ["string"],
    },
    eventBridge: {
        detail: "string",
        detailType: "string",
        eventBusArn: "string",
        roleName: "string",
        source: "string",
    },
    jira: {
        url: "string",
        apiToken: "string",
        email: "string",
        projectKey: "string",
    },
    microsoftTeamsWorkflow: {
        url: "string",
    },
    name: "string",
    opsgenie: {
        url: "string",
    },
    pagerDuty: {
        serviceKey: "string",
    },
    sendlog: {
        url: "string",
        payload: "string",
        uuid: "string",
    },
    slack: {
        attachments: [{
            type: "string",
            active: false,
        }],
        notifyOns: ["string"],
        url: "string",
    },
});
Copy
type: coralogix:Webhook
properties:
    custom:
        headers:
            string: string
        method: string
        payload: string
        url: string
        uuid: string
    demisto:
        payload: string
        url: string
        uuid: string
    emailGroup:
        emails:
            - string
    eventBridge:
        detail: string
        detailType: string
        eventBusArn: string
        roleName: string
        source: string
    jira:
        apiToken: string
        email: string
        projectKey: string
        url: string
    microsoftTeamsWorkflow:
        url: string
    name: string
    opsgenie:
        url: string
    pagerDuty:
        serviceKey: string
    sendlog:
        payload: string
        url: string
        uuid: string
    slack:
        attachments:
            - active: false
              type: string
        notifyOns:
            - string
        url: string
Copy

Webhook Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Webhook resource accepts the following input properties:

Custom WebhookCustom
Generic webhook.
Demisto WebhookDemisto
Demisto webhook.
EmailGroup WebhookEmailGroup
Email group webhook.
EventBridge WebhookEventBridge
Jira WebhookJira
Jira webhook.
MicrosoftTeams WebhookMicrosoftTeams
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

MicrosoftTeamsWorkflow WebhookMicrosoftTeamsWorkflow
Microsoft Teams Workflow webhook.
Name string
Webhook name.
Opsgenie WebhookOpsgenie
Opsgenie webhook.
PagerDuty WebhookPagerDuty
PagerDuty webhook.
Sendlog WebhookSendlog
Send log webhook.
Slack WebhookSlack
Slack webhook.
Custom WebhookCustomArgs
Generic webhook.
Demisto WebhookDemistoArgs
Demisto webhook.
EmailGroup WebhookEmailGroupArgs
Email group webhook.
EventBridge WebhookEventBridgeArgs
Jira WebhookJiraArgs
Jira webhook.
MicrosoftTeams WebhookMicrosoftTeamsArgs
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

MicrosoftTeamsWorkflow WebhookMicrosoftTeamsWorkflowArgs
Microsoft Teams Workflow webhook.
Name string
Webhook name.
Opsgenie WebhookOpsgenieArgs
Opsgenie webhook.
PagerDuty WebhookPagerDutyArgs
PagerDuty webhook.
Sendlog WebhookSendlogArgs
Send log webhook.
Slack WebhookSlackArgs
Slack webhook.
custom WebhookCustom
Generic webhook.
demisto WebhookDemisto
Demisto webhook.
emailGroup WebhookEmailGroup
Email group webhook.
eventBridge WebhookEventBridge
jira WebhookJira
Jira webhook.
microsoftTeams WebhookMicrosoftTeams
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

microsoftTeamsWorkflow WebhookMicrosoftTeamsWorkflow
Microsoft Teams Workflow webhook.
name String
Webhook name.
opsgenie WebhookOpsgenie
Opsgenie webhook.
pagerDuty WebhookPagerDuty
PagerDuty webhook.
sendlog WebhookSendlog
Send log webhook.
slack WebhookSlack
Slack webhook.
custom WebhookCustom
Generic webhook.
demisto WebhookDemisto
Demisto webhook.
emailGroup WebhookEmailGroup
Email group webhook.
eventBridge WebhookEventBridge
jira WebhookJira
Jira webhook.
microsoftTeams WebhookMicrosoftTeams
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

microsoftTeamsWorkflow WebhookMicrosoftTeamsWorkflow
Microsoft Teams Workflow webhook.
name string
Webhook name.
opsgenie WebhookOpsgenie
Opsgenie webhook.
pagerDuty WebhookPagerDuty
PagerDuty webhook.
sendlog WebhookSendlog
Send log webhook.
slack WebhookSlack
Slack webhook.
custom WebhookCustomArgs
Generic webhook.
demisto WebhookDemistoArgs
Demisto webhook.
email_group WebhookEmailGroupArgs
Email group webhook.
event_bridge WebhookEventBridgeArgs
jira WebhookJiraArgs
Jira webhook.
microsoft_teams WebhookMicrosoftTeamsArgs
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

microsoft_teams_workflow WebhookMicrosoftTeamsWorkflowArgs
Microsoft Teams Workflow webhook.
name str
Webhook name.
opsgenie WebhookOpsgenieArgs
Opsgenie webhook.
pager_duty WebhookPagerDutyArgs
PagerDuty webhook.
sendlog WebhookSendlogArgs
Send log webhook.
slack WebhookSlackArgs
Slack webhook.
custom Property Map
Generic webhook.
demisto Property Map
Demisto webhook.
emailGroup Property Map
Email group webhook.
eventBridge Property Map
jira Property Map
Jira webhook.
microsoftTeams Property Map
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Webhook resource produces the following output properties:

ExternalId string
Webhook external ID. Using to linq webhook to alert.
Id string
The provider-assigned unique ID for this managed resource.
ExternalId string
Webhook external ID. Using to linq webhook to alert.
Id string
The provider-assigned unique ID for this managed resource.
externalId String
Webhook external ID. Using to linq webhook to alert.
id String
The provider-assigned unique ID for this managed resource.
externalId string
Webhook external ID. Using to linq webhook to alert.
id string
The provider-assigned unique ID for this managed resource.
external_id str
Webhook external ID. Using to linq webhook to alert.
id str
The provider-assigned unique ID for this managed resource.
externalId String
Webhook external ID. Using to linq webhook to alert.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Webhook Resource

Get an existing Webhook 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?: WebhookState, opts?: CustomResourceOptions): Webhook
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom: Optional[WebhookCustomArgs] = None,
        demisto: Optional[WebhookDemistoArgs] = None,
        email_group: Optional[WebhookEmailGroupArgs] = None,
        event_bridge: Optional[WebhookEventBridgeArgs] = None,
        external_id: Optional[str] = None,
        jira: Optional[WebhookJiraArgs] = None,
        microsoft_teams: Optional[WebhookMicrosoftTeamsArgs] = None,
        microsoft_teams_workflow: Optional[WebhookMicrosoftTeamsWorkflowArgs] = None,
        name: Optional[str] = None,
        opsgenie: Optional[WebhookOpsgenieArgs] = None,
        pager_duty: Optional[WebhookPagerDutyArgs] = None,
        sendlog: Optional[WebhookSendlogArgs] = None,
        slack: Optional[WebhookSlackArgs] = None) -> Webhook
func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)
public static Webhook Get(string name, Input<string> id, WebhookState? state, CustomResourceOptions? opts = null)
public static Webhook get(String name, Output<String> id, WebhookState state, CustomResourceOptions options)
resources:  _:    type: coralogix:Webhook    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Custom WebhookCustom
Generic webhook.
Demisto WebhookDemisto
Demisto webhook.
EmailGroup WebhookEmailGroup
Email group webhook.
EventBridge WebhookEventBridge
ExternalId string
Webhook external ID. Using to linq webhook to alert.
Jira WebhookJira
Jira webhook.
MicrosoftTeams WebhookMicrosoftTeams
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

MicrosoftTeamsWorkflow WebhookMicrosoftTeamsWorkflow
Microsoft Teams Workflow webhook.
Name string
Webhook name.
Opsgenie WebhookOpsgenie
Opsgenie webhook.
PagerDuty WebhookPagerDuty
PagerDuty webhook.
Sendlog WebhookSendlog
Send log webhook.
Slack WebhookSlack
Slack webhook.
Custom WebhookCustomArgs
Generic webhook.
Demisto WebhookDemistoArgs
Demisto webhook.
EmailGroup WebhookEmailGroupArgs
Email group webhook.
EventBridge WebhookEventBridgeArgs
ExternalId string
Webhook external ID. Using to linq webhook to alert.
Jira WebhookJiraArgs
Jira webhook.
MicrosoftTeams WebhookMicrosoftTeamsArgs
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

MicrosoftTeamsWorkflow WebhookMicrosoftTeamsWorkflowArgs
Microsoft Teams Workflow webhook.
Name string
Webhook name.
Opsgenie WebhookOpsgenieArgs
Opsgenie webhook.
PagerDuty WebhookPagerDutyArgs
PagerDuty webhook.
Sendlog WebhookSendlogArgs
Send log webhook.
Slack WebhookSlackArgs
Slack webhook.
custom WebhookCustom
Generic webhook.
demisto WebhookDemisto
Demisto webhook.
emailGroup WebhookEmailGroup
Email group webhook.
eventBridge WebhookEventBridge
externalId String
Webhook external ID. Using to linq webhook to alert.
jira WebhookJira
Jira webhook.
microsoftTeams WebhookMicrosoftTeams
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

microsoftTeamsWorkflow WebhookMicrosoftTeamsWorkflow
Microsoft Teams Workflow webhook.
name String
Webhook name.
opsgenie WebhookOpsgenie
Opsgenie webhook.
pagerDuty WebhookPagerDuty
PagerDuty webhook.
sendlog WebhookSendlog
Send log webhook.
slack WebhookSlack
Slack webhook.
custom WebhookCustom
Generic webhook.
demisto WebhookDemisto
Demisto webhook.
emailGroup WebhookEmailGroup
Email group webhook.
eventBridge WebhookEventBridge
externalId string
Webhook external ID. Using to linq webhook to alert.
jira WebhookJira
Jira webhook.
microsoftTeams WebhookMicrosoftTeams
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

microsoftTeamsWorkflow WebhookMicrosoftTeamsWorkflow
Microsoft Teams Workflow webhook.
name string
Webhook name.
opsgenie WebhookOpsgenie
Opsgenie webhook.
pagerDuty WebhookPagerDuty
PagerDuty webhook.
sendlog WebhookSendlog
Send log webhook.
slack WebhookSlack
Slack webhook.
custom WebhookCustomArgs
Generic webhook.
demisto WebhookDemistoArgs
Demisto webhook.
email_group WebhookEmailGroupArgs
Email group webhook.
event_bridge WebhookEventBridgeArgs
external_id str
Webhook external ID. Using to linq webhook to alert.
jira WebhookJiraArgs
Jira webhook.
microsoft_teams WebhookMicrosoftTeamsArgs
Microsoft Teams webhook. (Deprecated, please use microsoftteamsworkflow)

Deprecated: Deprecated

microsoft_teams_workflow WebhookMicrosoftTeamsWorkflowArgs
Microsoft Teams Workflow webhook.
name str
Webhook name.
opsgenie WebhookOpsgenieArgs
Opsgenie webhook.
pager_duty WebhookPagerDutyArgs
PagerDuty webhook.
sendlog WebhookSendlogArgs
Send log webhook.
slack WebhookSlackArgs
Slack webhook.
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)

Deprecated: Deprecated

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.

Supporting Types

WebhookCustom
, WebhookCustomArgs

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.

WebhookDemisto
, WebhookDemistoArgs

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

WebhookEmailGroup
, WebhookEmailGroupArgs

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.

WebhookEventBridge
, WebhookEventBridgeArgs

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

WebhookJira
, WebhookJiraArgs

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

WebhookMicrosoftTeams
, WebhookMicrosoftTeamsArgs

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.

WebhookMicrosoftTeamsWorkflow
, WebhookMicrosoftTeamsWorkflowArgs

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.

WebhookOpsgenie
, WebhookOpsgenieArgs

Url This property is required. string
Opsgenie URL.
Url This property is required. string
Opsgenie URL.
url This property is required. String
Opsgenie URL.
url This property is required. string
Opsgenie URL.
url This property is required. str
Opsgenie URL.
url This property is required. String
Opsgenie URL.

WebhookPagerDuty
, WebhookPagerDutyArgs

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.

WebhookSendlog
, WebhookSendlogArgs

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

WebhookSlack
, WebhookSlackArgs

Attachments List<WebhookSlackAttachment>
Slack attachments.
NotifyOns List<string>
Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
Url string
Slack URL.
Attachments []WebhookSlackAttachment
Slack attachments.
NotifyOns []string
Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
Url string
Slack URL.
attachments List<WebhookSlackAttachment>
Slack attachments.
notifyOns List<String>
Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
url String
Slack URL.
attachments WebhookSlackAttachment[]
Slack attachments.
notifyOns string[]
Slack notifications. can be one of: datausage, errorandcriticallogs, flowanomalies, spikeanomalies
url string
Slack URL.
attachments Sequence[WebhookSlackAttachment]
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.

WebhookSlackAttachment
, WebhookSlackAttachmentArgs

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

Package Details

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