Webhook alert channel

{
  "issue": {
    "id": "53650436-8e35-49a3-a610-56b442ae7620",
    "type": "issue",
    "state": "OPEN",
    "start": 1460537793322,
    "severity": 5,
    "text": "Garbage Collection Activity High (11%)",
    "suggestion": "Tune your Garbage Collector, reduce allocation rate through code changes",
    "link": "https://XXXXXXX/#/?snapshotId=rjhkZXdNzegliVVEswMScGNn0YY",
    "zone": "prod",
    "fqdn": "host1.demo.com",
    "entity": "jvm",
    "entityLabel": "Test jvm",
    "tags": "production, documents, elasticsearch",
    "container": "test-container"
  }
}
 

{
  "issue": {
    "id": "53650436-8e35-49a3-a610-56b442ae7620",
    "type": "issue",
    "state": "CLOSED",
    "start": 1460537793322,
    "end": 1460538393322,
    "severity": 5,
    "text": "Garbage Collection Activity High (11%)",
    "suggestion": "Tune your Garbage Collector, reduce allocation rate through code changes",
    "link": "https://XXXXXXX/#/?snapshotId=rjhkZXdNzegliVVEswMScGNn0YY",
    "zone": "prod",
    "fqdn": "host1.demo.com",
    "entity": "jvm",
    "entityLabel": "Test jvm",
    "tags": "production, documents, elasticsearch",
    "container": "test-container"
  }
}
 

{
    "issue": {
        "id": "G9KRvijARFw6vffuygCvl_Fyg",
        "type": "change",
        "start": 1743798954000,
        "text": "Change detected",
        "description": "The value has changed from X to Y.\n",
        "link": "https://X/#/events;eventId=G9KRvijARFw6vffuygCvl_Fyg?&snapshotId=mTraati8sdfl0H5qrEagmIRIBYoM4",
        "end": 1743798954000,
        "zone": "prod",
        "fqdn": "something.com",
        "entity": "Kubernetes Pod",
        "entityLabel": "Test",
        "tags": "docs",
        "container": "b-container"
        }
    }
}
 

{
  "issue": {
    "id": "53650436-8e35-49a3-a610-56b442ae7620",
    "type": "presence",
    "start": 1460537793322,
    "text": "online",
    "description": "Java virtual machine on Host host1.demo.com",
    "link": "https://XXXXXXX/#/?snapshotId=rjhkZXdNzegliVVEswMScGNn0YY",
    "zone": "prod",
    "fqdn": "host1.demo.com",
    "entity": "jvm",
    "entityLabel": "Test jvm",
    "tags": "production, documents, elasticsearch",
    "container": "test-container"
  }
}
 

{
    "issue": {
        "id": "ah7cCh99TjGqnZJ4UL-uZHA",
        "type": "monitoringIssue",
        "state": "OPEN",
        "start": 1743798151988,
        "severity": 5,
        "text": "Monitoring issue: nodejs_collector_not_installed",
        "suggestion": "Our Agent observed a problem with monitoring the linked process.",
        "link": "https://XX/#/events;eventId=ah7cCh99TjGqnZJ4UL-uZHA?&snapshotId=UhgAKBptVGeu04DsagNGU",
        "zone": "ava",
        "fqdn": "cool.fyre.ibm.com",
        "entity": "Process",
        "entityLabel": "node  (7532267)",
        "tags": "proc",
        "container": "c-container"
    }
}
 

Some Webhook integrations need the specification of additional Headers that can be added in this section. An example is the addition of an API token for AWS API Gateway.

As an alternative to providing the respective Authorization HTTP request header manually, you can use HTTP basic authentication via the webhook URL. By prepending username and password to the hostname, such as https://username:password@webhookurl.com, the credentials are automatically Base64-encoded and provided as the following HTTP header value:

Authorization: Basic <base64 encoded credentials>
 

The transformation expression is applied globally at the alert channel level and affects all alerts sent through that channel. Consider the following guidelines:

• Alert-specific transformations: If you need different transformations for different alerts, create multiple webhook alert channels, each with its own transformation expression.
• Error handling: Invalid JSONata expressions might cause alert delivery failures. Ensure your expressions are valid and handle potential null or missing values appropriately by using the Test Channel button before creating your config.

JSONata is a lightweight query and transformation language for JSON data. For detailed information about JSONata syntax, see JSONata documentation.

To create a webhook alert channel with transformation, include the optional transformationExpression field in your API request to the POST /api/events/settings/alertingChannels endpoint. The transformationExpression field must follow the JSONata syntax, as shown in the following example. For complete API details, see Instana OpenAPI specification.

{
    "transformationExpression": "{\"issue\": $merge([issue, {\"metricNames\": issue.text}])}",
    "headers": [],
    "rbacTags": [],
    "webhookUrls": [
        "https://webhook.example.com/endpoint"
    ],
    "kind": "WEB_HOOK",
    "name": "Transformed Webhook",
    "oauthEnabled": false
}
 

The Instana backend are issuing requests from AWS/Google Cloud servers. Therefore, it is important that the JavaScript and source map files are generally accessible from the internet. Additionally, make sure that your backend has a working TLS configuration with a complete certificate chain. You can check for any TLS issues by using the free SSL Test from SSL Labs/Qualys or by running the following command:

openssl s_client -showcerts -connect {{YOUR_DOMAIN_HERE}}:443