Notification Payload

Causely sends structured JSON payloads to all webhook-based integrations. Whether you're using Slack, Prometheus Alertmanager, Splunk On-Call, Microsoft Teams, or a custom system, the notification format below applies consistently.

Webhook Notification Payload Example

Here is an example of a notification payload that will be sent to your webhook:

{
  'name': 'Malfunction',
  'type': 'ProblemDetected',
  'entity': { 'id': '80551c4b-b557-4652-88cd-f210c620f154', 'name': 'causely/gateway', 'type': 'Controller' },
  'description': 'Multiple instances are experiencing malfunction',
  'timestamp': '2024-09-08T11:38:00Z',
  'labels':
    {
      'k8s.cluster.name': 'dev',
      'k8s.cluster.uid': '919a6620-4466-454f-87d9-4b877a6ddf82',
      'k8s.namespace.name': 'causely',
    },
  'objectId': '1f183001-79d7-4928-b9cb-725e22cf0e50',
}

Payload fields:

• name: The event name, in this case it's the problem name.
• type: The type of notification (for example, "ProblemDetected").
• entity: The details regarding the entity for which the notification is triggered:
• Id: Id of the entity
• name: Name of the entity
• type: Type of the entity
• description: A description of the issue.
• timestamp: The timestamp when the issue was detected.
• labels: Metadata or tags that provide additional context (for example, app name, Kubernetes namespace, and cluster information).
• objectId: A unique identifier for the specific object associated with this event, in this case it's the problem Id.