Chapter 27. Notifications

• Job templates use notification templates defined for them. Additionally, they can inherit notification templates from the project used by the job template, and from the organization that it is listed under.
• Project updates use notification templates defined on the project and inherit notification templates from the organization associated with it.
• Inventory updates use notification templates defined on the organization that it is listed under.
• Ad hoc commands use notification templates defined on the organization that the inventory is associated with.

• Email
• Grafana
• IRC
• Mattermost
• PagerDuty
• Rocket.Chat
• Slack
• Twilio

• Webhook

  • Webhook payloads

• Messages are always just strings, one-liners only. New lines are not supported.

• Message bodies are either a dictionary or a block of text:

  • The message body for Webhooks and PagerDuty uses dictionary definitions. The default message body for these is {{ job_metadata }}, you can either leave that as it is or provide your own dictionary.

  • The message body for email uses a block of text or a multi-line string. The default message body is:

    {{ job_friendly_name }} #{{ job.id }} had status {{ job.status }}, view details at {{ url }} {{ job_metadata }}

    You can edit this text leaving {{ job_metadata }} in, or drop {{ job_metadata }}. Since the body is a block of text, it can be any string you want. {{ job_metadata }} is rendered as a dictionary containing fields that describe the job being executed. In all cases, {{ job_metadata }} includes the following fields:

    • id
    • name
    • url
    • created_by
    • started
    • finished
    • status

    • traceback

      Note

      You cannot query individual fields within {{ job_metadata }}. When you use {{ job_metadata }} in a notification template, all data is returned.

      The resulting dictionary looks like the following:

      {"id": 18,
       "name": "Project - Space Procedures",
       "url": "https://host/#/jobs/project/18",
       "created_by": "admin",
       "started": "2019-10-26T00:20:45.139356+00:00",
       "finished": "2019-10-26T00:20:55.769713+00:00",
       "status": "successful",
       "traceback": ""
      }

      If {{ job_metadata }} is rendered in a job, it includes the following additional fields:

    • inventory
    • project
    • playbook
    • credential
    • limit
    • extra_vars

    • hosts

      The resulting dictionary looks like the following:

      {"id": 12,
       "name": "JobTemplate - Launch Rockets",
       "url": "https://host/#/jobs/playbook/12",
       "created_by": "admin",
       "started": "2019-10-26T00:02:07.943774+00:00",
       "finished": null,
       "status": "running",
       "traceback": "",
       "inventory": "Inventory - Fleet",
       "project": "Project - Space Procedures",
       "playbook": "launch.yml",
       "credential": "Credential - Mission Control",
       "limit": "",
       "extra_vars": "{}",
       "hosts": {}
      }

      If {{ job_metadata }} is rendered in a workflow job, it includes the following additional field:

    • body (This enumerates the nodes in the workflow job and includes a description of the job associated with each node)

      The resulting dictionary looks like the following:

      {"id": 14,
       "name": "Workflow Job Template - Launch Mars Mission",
       "url": "https://host/#/workflows/14",
       "created_by": "admin",
       "started": "2019-10-26T00:11:04.554468+00:00",
       "finished": "2019-10-26T00:11:24.249899+00:00",
       "status": "successful",
       "traceback": "",
       "body": "Workflow job summary:
      
               node #1 spawns job #15, \"Assemble Fleet JT\", which finished with status successful.
               node #2 spawns job #16, \"Mission Start approval node\", which finished with status successful.\n
               node #3 spawns job #17, \"Deploy Fleet\", which finished with status successful."
      }

Additional resources

• For more information, see Using variables with Jinja2.
• Automation controller requires valid syntax to retrieve the correct data to display the messages. For a list of supported attributes and the proper syntax construction, see the Supported Attributes for Custom Notifications section.

• If a workflow job template has notification on start enabled, and a job template within that workflow also has notification on start enabled, you receive notifications for both.
• You can enable notifications to run on many job templates within a workflow job template.
• You can enable notifications to run on a sliced job template start and each slice generates a notification.
• When you enable a notification to run on job start, and that notification gets deleted, the job template continues to run, but results in an error message.

• Job Templates
• Workflow Templates
• Projects (shown in the following example)
• Inventory Sources
• Organizations

• Organizations
• Projects
• Inventory Sources
• Job Templates
• System Job Templates
• Workflow Job Templates