HomeTyk Dashboard v1.xEventsNotifications and Events

Notifications and Events

Tyk Dashboard and the portal no support email notifications powered by Mandrill, Sendgrid, Mailgun and Amazon SES.

To configure your email back-end please see the sending emails section

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.

Events

The dashboard and portal 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:

api_event

When an API is Created, updated or deleted

key_event

When a key is Created, updated or deleted.

key_request_event

When a portal key request is created or updated.

Was this article helpful to you? Yes No