HomeTyk Dashboard v0.9EventsNotifications and Events

Notifications and Events

Tyk Dashboard and the portal no support email notifications powered by Mandrill (though other back-ends can be developed), mandrill is a free email API that handles emails, templates and list subscription for you, it was chosen for it’s ease of setup vs. a traditional SMTP server.

In order to enable email support in the portal and dashboard, you will need to add the configuration block to your tyk_analytics.conf file:

"email_backend": {
    "enable_email_notifications": true,
    "code": "mandrill",
    "settings": {
        "ClientKey": "YOUR-KEY"
    "default_from_email": "[email protected]",
    "default_from_name": "Foo at Bar.com"

You can sign up for a mandrill account here.

How email notifications work.

If you have enabled email notifications, the portal will attempt to send notifications regarding a users sign-up status or key request status to their username email-address. these templates can be found in the portal/email_templates folder.

the templates are twofold, text-only and html, please see the standard included ones to see the various template fields that can be customised.


The dashboard and portal now also support a certain level of events that you can use to notify your systems of various things that have happened in the portal.

To configure them, add an event_options section to an Organisation document when you are creating them (see the Advanced Management API documentation to see how to create an Organisation record using the API).

Within this object, you can then register either webhooks or an email address to notify when an event occurs:

event_options: {
    api_event: {
      webhook: "http://posttestserver.com/post.php?dir=tyk-events",
      email: "[email protected]"
    key_event: {
      webhook: "http://posttestserver.com/post.php?dir=tyk-key-events",
      email: "[email protected]"
    key_request_event: {
      webhook: "http://posttestserver.com/post.php?dir=tyk-key-events",
      email: "[email protected]"

The following events are supported:


When an API is Created, updated or deleted


When a key is Created, updated or deleted.


When a portal key request is created or updated.

Was this article helpful to you? Yes No