Sending Notifications¶
Tabbycat offers integrations with email delivery services to send notifications to participants on certain enumerated events. For sending these emails, SendGrid is readily available as an add-on in Heroku. It may be necessary to install the SendGrid add-on manually. Other integrations may also be used in its place by changing the relevant environment variables.
Events¶
Tabbycat includes a number of templated notifications that can be sent in various times. Variables which are included between curly brackets which are substituted for personalized information passed by email. Links to email will redirect to a page where the message can be changed and the participants selected.
All emails have the {{ USER }}
and {{ TOURN }}
variables to indicate who the email is sent to, and the tournament it relates to. The “From” in the emails will also be the tournament’s name.
Email content and description |
Variables |
---|---|
Adjudicator draw notification Email to adjudicators indicating their room assignment. Available through the admin draw page. |
|
Team draw notification Email to teams indicating their pairing. Available through the admin draw page. |
|
Private URL distribution Email to participants giving them their private URL for electronic forms. Available through the private URLs page. |
|
Ballot submission receipt Email to adjudicators of their ballot after tabroom confirmation. Sent automatically when their ballot’s result status becomes confirmed, if enabled in the “Notifications” section of the tournament options. |
|
Current team standings Email to speakers with their point total. Available through the “Confirm Round Completion” page. |
|
Motion release Email to speakers with the motion(s) of the current round. Available through the admin draw page. |
|
Team information Email to speakers with information pertaining to their team, such as eligibility and codes. Available through the Participants page. |
|
Event Webhook¶
With SendGrid, the status of sent emails can be sent to Tabbycat to be displayed, giving an indication of failures and whether participants have opened the messages. To activate this feature, setup must be done both in your SendGrid account and in Tabbycat.
Set a secret key in the Email section of the tournament’s preferences. This key must be alphanumeric without any spaces.
Copy the “web-hook” link presented in a box at the top of the “email participants” page.
Go to https://app.sendgrid.com/settings/mail_settings and select “Event Notifications”
Enable the feature and paste the Tabbycat URL under “HTTP POST URL”.
Select the notifications to keep track (or all of them).
Caution
Each email and change in status sent to Tabbycat will add a row to the database. If the number of rows is limited, as is for free Heroku apps, enabling the webhook may use up a significant number of rows. Be selective in the events to keep track.