🚀 updated for python 3.8.6 and zenpy changes

Author: ChipWolf

.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+lza.p

README.md

@@ -1,6 +1,24 @@
 # zendesk-discord-webhook-bot
 Discord Webhook Bot for Zendesk
 
+## Usage
+
+Tested with Python 3.8.2:
+```bash
+pip3 install -r requirements.txt
+
+export ZDWB_DISCORD_WEBHOOK="https://discordapp.com/api/webhooks/...."
+export ZDWB_ZENDESK_EMAIL="richard.hendricks@piedpiper.com"
+export ZDWB_ZENDESK_TOKEN="abcdefghijklmnopqrstuvwxyz1234567890"
+export ZDWB_ZENDESK_SUBDOMAIN="piedpiper"
+
+python3 bot.py
+```
+
+`ZDWB_HISTORY_MINUTES` may also be set as an environment variable to signal the application on first run to collect the number of minutes you specify of historical data from Zendesk to post to the webhook channel.
+
+## Screenshots
+
 ![](https://i.cwlf.uk/evKB)
 
 ![](https://i.cwlf.uk/AZPl)

bot.py

@@ -1,59 +1,70 @@
 import sys
 import os
-import time, datetime
+import time, datetime, pytz
 import urllib, hashlib
 import pickle
 import traceback
+import logging
 from dateutil import parser
 from zenpy import Zenpy
 sys.path.append(os.path.join(os.path.dirname(os.path.realpath(__file__)), os.pardir))
 from discordWebhooks import Webhook, Attachment, Field
 
-# CONFIGS
+logging.basicConfig()
+logger = logging.getLogger('ZDWB')
+logger.setLevel(logging.INFO)
 
-url = "<discord webhook url>"
+if os.environ['ZDWB_HISTORY_MINUTES']:
+    history_minutes = int(os.environ['ZDWB_HISTORY_MINUTES'])
+else:
+    history_minutes = 0
+
+url = os.environ['ZDWB_DISCORD_WEBHOOK']
 
 creds = {
-    'email' : 'user@example.org',
-    'token' : '<zendesk token>',
-    'subdomain' : '<zendesk subdomain>'
+    'email' : os.environ['ZDWB_ZENDESK_EMAIL'],
+    'token' : os.environ['ZDWB_ZENDESK_TOKEN'],
+    'subdomain' : os.environ['ZDWB_ZENDESK_SUBDOMAIN']
 }
 
-# END CONFIGS
-
 status_color = {
     'new' : '#F5CA00',
     'open' : '#E82A2A',
     'pending' : '#59BBE0',
-    'hold' : '#000',
+    'hold' : '#000000',
     'solved' : '#828282',
-    'closed' : '#ddd'
+    'closed' : '#DDDDDD'
 }
 
+default_icon = "https://d1eipm3vz40hy0.cloudfront.net/images/logos/favicons/favicon.ico"
+
 zenpy = Zenpy(**creds)
 
 tickets = {}
 
+# Check if we know the last timestamp Zendesk was audited from
 if os.path.isfile('lza.p') is True: # lza = Last Zendesk Audit
     lza = pickle.load(open('lza.p','rb'))
+    first_run = False
 else:
+    lza = datetime.datetime.utcnow().replace(tzinfo=pytz.UTC)
     first_run = True
-    lza = datetime.datetime.utcnow()
 
-print(lza)
+logger.info('Last Zendesk Audit: {}'.format(lza))
 
 pickle.dump(lza,open('lza.p','wb'))
 
 def get_gravatar(email):
-    default = "https://{}.zendesk.com/images/favicon_2.ico".format(creds['subdomain'])
-    avatar = "https://www.gravatar.com/avatar/" + hashlib.md5(email.encode("utf8").lower()).hexdigest() + "?"
-    avatar += urllib.parse.urlencode({'d':default})
+    # This will display the default Gravatar icon if the user has no Gravatar
+    avatar = "https://www.gravatar.com/avatar/" + hashlib.md5(email.encode("utf8").lower()).hexdigest()
     return avatar
 
 def post_webhook(event):
     try:
         ticket = zenpy.tickets(id=event.ticket_id)
         requester = zenpy.users(id=ticket.requester_id)
+
+        # Updater ID 0 is generally for Zendesk automation/non-user actions
         if event.updater_id > 0:
             updater = zenpy.users(id=event.updater_id)
             updater_name = updater.name
@@ -62,44 +73,58 @@ def post_webhook(event):
             updater_name = "Zendesk System"
             updater_email = "support@zendesk.com"
 
+        # If the user has no Zendesk profile photo, use Gravatar
         if requester.photo is not None:
-            avatar = requester.photo.content_url
+            avatar = requester.photo['content_url']
         else:
             avatar = get_gravatar(requester.email)
 
+        # Initialize an empty Discord Webhook object with the specified Webhook URL
         wh = Webhook(url, "", "", "")
 
+        # Prepare the base ticket info embed (attachment)
         at = Attachment(
             author_name = '{} ({})'.format(requester.name,requester.email),
             author_icon = avatar,
             color = status_color[ticket.status],
             title = '[Ticket #{}] {}'.format(ticket.id,ticket.raw_subject),
             title_link = "https://{}.zendesk.com/agent/#/tickets/{}".format(creds['subdomain'],ticket.id),
             footer = ticket.status.title(),
-            ts = int(parser.parse(ticket.created_at).strftime('%s')))
+            ts = int(parser.parse(ticket.created_at).strftime('%s'))) # TODO: always UTC, config timezone
 
-        for child in event._child_events:
+        # If this is a new ticket, post it, ignore the rest.
+        # This will only handle the first 'Create' child event
+        # I have yet to see any more than one child event for new tickets
+        for child in event.child_events:
            if child['event_type'] == 'Create':
                if first_run is True:
                    wh = Webhook(url, "", "", "")
                else:
                    wh = Webhook(url, "@here, New Ticket!", "", "")
+
+
                description = ticket.description
+
+               # Strip any double newlines from the description
                while "\n\n" in description:
                    description = description.replace("\n\n", "\n")
+
                field = Field("Description", ticket.description, False)
                at.addField(field)
+
                wh.addAttachment(at)
                wh.post()
+
                return
 
         wh.addAttachment(at)
 
+        # Updater ID 0 is either Zendesk automation or non-user actions
         if int(event.updater_id) < 0:
             at = Attachment(
                 color = status_color[ticket.status],
                 footer = "Zendesk System",
-                footer_icon = "https://{}.zendesk.com/images/favicon_2.ico".format(creds['subdomain']),
+                footer_icon = default_icon,
                 ts = int(parser.parse(event.created_at).strftime('%s')))
         else:
             at = Attachment(
@@ -108,15 +133,18 @@ def post_webhook(event):
                 footer_icon = get_gravatar(updater_email),
                 ts = int(parser.parse(event.created_at).strftime('%s')))
 
-        for child in event._child_events:
+        for child in event.child_events:
            if child['event_type'] == 'Comment':
-               for comment in zenpy.tickets.comments(ticket.id).values:
-                    if comment['id'] == child['id']:
-                        comment_body = comment['plain_body']
+               for comment in zenpy.tickets.comments(ticket.id):
+                    if comment.id == child['id']:
+                        comment_body = comment.body
+
                         while "\n\n" in comment_body:
                             comment_body = comment_body.replace("\n\n","\n")
-                        field = Field("New Comment", comment['plain_body'], False)
+
+                        field = Field("Comment", comment_body, False)
                         at.addField(field)
+
            elif child['event_type'] == 'Change':
                if 'status' not in child.keys():
                    if 'tags' in child.keys():
@@ -139,43 +167,46 @@ def post_webhook(event):
                        field=Field("Type Change", '`{}`'.format(child['type']), True)
                        at.addField(field)
                    else:
-                       print(child)
+                       logger.debug(child)
                else:
-                   field = Field("Status Change", "{} from {}".format(child['status'].title(),child['previous_value'].title()), True)
+                   field = Field("Status Change", "{} to {}".format(child['previous_value'].title(), child['status'].title()), True)
                    at.addField(field)
            else:
-               print("Event not handled")
+               logger.error("Event not handled")
 
         wh.addAttachment(at)
+
         i = 0
         while i < 4:
+           logger.debug('Posting to Discord')
            r = wh.post()
            i += 1
-           if r.text is not 'ok':
-               if r.headers['X-RateLimit-Remaining'] == 0:
-                   now = int(time.time())
-                   then = int(r.headers['X-RateLimit-Reset'])
-                   ttw = then - now # ttw = Time To Wait
-                   if ttw > 0:
-                       print("Hit Rate Limit, sleeping for {}".format(str(ttw)))
-                       time.sleep(ttw)
-               else:
-                   break
+           if r.text != 'ok':
+               logger.error(r)
+               logger.info('Discord webhook retry {}/3'.format(i))
+           else:
+               break
            time.sleep(1)
 
     except Exception as e:
         if "RecordNotFound" in str(e):
             pass
         else:
-            traceback.print_exc()
+            logger.error(traceback.print_exc())
 
 if first_run is True:
-    for event in zenpy.tickets.events("1970-01-01T00:00:00Z"):
+    today = datetime.datetime.utcnow() - datetime.timedelta(minutes=history_minutes)
+    for event in zenpy.tickets.events(today.replace(tzinfo=pytz.UTC)):
+        logger.debug('Incoming Zendesk Event')
+        logger.debug(event.event_type)
+        for child in event.child_events:
+            logger.debug('Child Event')
+            logger.debug(child['event_type'])
         post_webhook(event)
 
 while True:
     for event in zenpy.tickets.events(lza):
         post_webhook(event)
-    lza = datetime.datetime.utcnow()
+    lza = datetime.datetime.utcnow().replace(tzinfo=pytz.UTC)
     pickle.dump(lza,open('lza.p','wb'))
-    time.sleep(5)
+    time.sleep(15)

requirements.txt

@@ -0,0 +1 @@
+zenpy==2.0.19