Skip to main content

Test an outgoing webhook

POSThttps://api.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

Request

Body

application/json

Request for testing an outgoing webhook configuration.

    data#object

    Outgoing webhook input data.

    oneOf
    object

    Aws event bridge config.

    Demisto config.

    Email group config.

    Generic webhook config.

    Ibm event notifications config.

    Jira config.

    data.microsoftTeams#object

    Microsoft teams config.

    data.msTeamsWorkflow#object

    Ms teams workflow config.

    data.name#string

    Display name.

    Example: my_webhook
    data.opsgenie#object

    Opsgenie config.

    Pager duty config.

    Send log config.

    Slack config.

    data.type#WebhookType

    Webhook type.

    Possible values: [UNKNOWN, GENERIC, SLACK, PAGERDUTY, SEND_LOG, EMAIL_GROUP, MICROSOFT_TEAMS, JIRA, OPSGENIE, DEMISTO, AWS_EVENT_BRIDGE, IBM_EVENT_NOTIFICATIONS, MS_TEAMS_WORKFLOW]

    data.url#string

    URL.

    Example: slack.webhook.com

Response

application/json

Response containing the results of an outgoing webhook test.

    oneOf
    object

    Failure.

    success#object

    Success.