Notification Template
=====================
Description
-----------
This resource is used for managing notification templates in Tower. Note most resource fields, like ``username``
and ``host`` are effective based on ``notification_type``. For example, providing ``service_key`` when creating
an email notification template is not effective as it will be discarded.
Fields Table
------------
..
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|name |type |help_text |read_only |unique |filterable |required |
+===========================+==========================================================+=============================================================================================================================+==========+=======+===========+=========+
|name |String |The name field. |False |True |True |True |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|description |String |The description field. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|organization |Resource organization |The organization field. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|notification_type |Choices: email,slack,twilio,pagerduty,hipchat,webhook,irc |The notification_type field. |False |False |True |True |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|notification_configuration |file |The notification configuration field. Note providing this field would disable all notification-configuration-related fields. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|username |String |[email]The username. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|sender |String |[email]The sender. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|recipients |String |[email]The recipients. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|use_tls |BOOL |[email]The tls trigger. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|host |String |[email]The host. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|use_ssl |BOOL |[email/irc]The ssl trigger. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|password |String |[email/irc]The password. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|port |INT |[email/irc]The email port. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|channels |String |[slack]The channel. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|token |String |[slack/pagerduty/hipchat]The token. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|account_token |String |[twilio]The account token. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|from_number |String |[twilio]The source phone number. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|to_numbers |String |[twilio]The destination SMS numbers. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|account_sid |String |[twilioThe account sid. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|subdomain |String |[pagerduty]The subdomain. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|service_key |String |[pagerduty]The API service/integration key. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|client_name |String |[pagerduty]The client identifier. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|message_from |String |[hipchat]The label to be shown with notification. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|api_url |String |[hipchat]The api url. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|color |Choices: yellow,green,red,purple,gray,random |[hipchat]The notification color. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|rooms |String |[hipchat]Rooms to send notification to. Use multiple flags to send to multiple rooms, ex --rooms=A --rooms=B |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|notify |String |[hipchat]The notify channel trigger. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|url |String |[webhook]The target URL. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|headers |file |[webhook]The http headers. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|server |String |[irc]Server address. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|nickname |String |[irc]The irc nick. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
|target |String |[irc]The distination channels or users. |False |False |True |False |
+---------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+----------+-------+-----------+---------+
..
API Specification
-----------------
.. autoclass:: tower_cli.resources.notification_template.Resource
:members: copy, create, delete, get, list, modify