Notifications

The Notifications module allows you to configure Jenkins to notify other applications about various build phases. It requires the Jenkins notification plugin.

Component: notifications
Macro:notification
Entry Point:jenkins_jobs.notifications
class notifications.Notifications(registry)
gen_xml(xml_parent, data)

Update the XML element tree based on YAML data. Override this method to add elements to the XML output. Create new Element objects and add them to the xml_parent. The YAML data structure must not be modified.

Parameters:
  • parser (YAMLParser) – the global YAML Parser
  • xml_parent (Element) – the parent XML element
  • data (dict) – the YAML data structure
http

Defines an HTTP notification endpoint. Requires the Jenkins Notification Plugin.

Parameters:
  • format (str) – notification payload format, JSON (default) or XML
  • event (str) – job events that trigger notifications: started, completed, finalized or all (default)
  • url (str) – URL of the endpoint
  • timeout (str) – Timeout in milliseconds for sending notification request (30 seconds by default)
  • log (str) – Number lines of log messages to send (0 by default). Use -1 for all (use with caution).

Example:

notifications:
  - http:
      url: http://example.com/jenkins_endpoint
      format: xml
      event: completed
      timeout: 40000
      log: -1