Test an outgoing webhook

POSThttps://api.eu1.coralogix.com/mgmt/openapi/5/integrations/webhooks-test/v1

Tests an outgoing webhook configuration.

Requires the following permissions:

• outbound-webhooks:ReadConfig

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

Request for testing an outgoing webhook configuration.

data#objectrequired
Outgoing webhook input data. The selected config determines the type. A URL is required for Generic, Slack, Microsoft Teams workflow, Jira, Opsgenie, and Demisto webhooks. Microsoft Teams writes are rejected because this type is deprecated. Send Log needs no URL. A service policy may reject a supplied Send Log URL. An update replaces the config and cannot change the webhook type.
oneOf
• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10
• Option 11
• Option 12
object
data.awsEventBridge# object
Aws event bridge config.
data.demisto# object
Demisto config.
data.emailGroup# object
Email group config.
data.genericWebhook# object
Generic webhook config.
data.ibmEventNotifications# object
Ibm event notifications config.
data.jira# object
Jira config.
data.microsoftTeams#object
Microsoft teams config.
data.msTeamsWorkflow#object
Ms teams workflow config.
data.name#stringrequired
Display name.
Possible values: non-empty
Example: my_webhook
data.opsgenie#object
Opsgenie config.
data.pagerDuty# object
Pager duty config.
data.sendLog# object
Send log config.
data.slack# object
Slack config.
data.url#string
URL.
Example: slack.webhook.com

Response

200400401500application/json

Response containing the results of an outgoing webhook test.

oneOf
• Option 1
• Option 2
• Option 3
object
failure# object
Failure.
success#object

Success.