Table of Contents
What is WatcherBot?
WatcherBot is a tool designed to keep editorial teams informed about the status of their edition uploads. Currently in Beta, it provides notifications via email or Slack about successful uploads or issues, such as failed pages.
How does it work?
The edition page check is based on page references sent in the edition payload - usually GUIDs or page reference numbers i. e an edition is uploaded with 132 pages, the notification is then based on all pages successfully processed in the Distribution Service. The notification output displays a breakdown of page type imported split by pdf/html.
Notification Subject Titles
“Edition title” is OK
“Edition title” has problems
“Edition title” is now OK [edition initially imported with problems that have since fixed]
“Edition title” has updated problems [edition import issues have updated since initial import]
Edition [edition ID] not found
What is needed to set this up?
Please provide a suitable group email to configure for editorial notifications. We can also set up a Slack hook to an external Slack channel, using both the channel name and channel API token. If you'd like to set it up to go to a Kaldor Slack shared channel, we'd only need the channel name. You should share these details securely with Support or your CSM.
Currently WatcherBot can be enabled with the following importers:
- .epub
- hpub
- BG custom importer
Non-existent editions
We can also set up notifications for when an edition is not published at the expected time. To configure this, we'll need the edition IDs and publish time to be consistent enough to set up a schedule. We'll probably add a small buffer to the scheduled time to allow for editions to complete uploading. This setup pertains mainly to daily editions.
Troubleshooting
Spam Email Filtering
Some email groups may filter WatcherBot notifications, leaving them in a "Pending" state—especially if multiple daily editions generate a high volume of emails.
For Google Groups, go to Conversations > Pending and approve emails if necessary.