Webhooks

Webhooks allows for external system to be automatically notified of various events within BrainEngine. Benefits include:

• The ability to see/know the current health status of the BrainEngine platform.

• The ability to ascertain the parts of the platform that are functioning and the ones that are experiencing problems.

• Any component or sub-component that goes down should raise an alert to the administrator or trigger a corrective operation.

Supported Platforms

Please follow the instructions provided by the manufactures on how to enable incoming webhooks.

Microsoft Teams

Please see Teams documentation for full details.

Slack

Please see Slack documentation for full details.

Custom Endpoints

Please contact your system administration on how to process the following health notifications.

Service Failure Notification

{
  "text": "The HealthCheck [[LIVENESS]] is failing with the error message [[FAILURE]]. <http://yourappstatus|Click here> to get more details.",
  "channel": "#general",
  "link_names": 1,
  "username": "brainengine",
  "icon_emoji": "brain"
}

Service Restoration Notification

{
  "text": "The HealthCheck [[LIVENESS]] is recovered. All is up and running",
  "channel": "#general",
  "link_names": 1,
  "username": "monkey-bot",
  "icon_emoji": ":monkey_face"
}