Last active
November 23, 2015 20:29
-
-
Save padwasabimasala/079cc6d6deb7de510c1b to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# DRAFT - Event Publishing Spec | |
The purpose of this doc is to define some simple guidelines for event publishing to be used on our teams | |
## Why publish events? | |
## What is a domain? | |
## Queue Names | |
environment . product/dept . domain . eventType | |
production.ntp.users.userCreated | |
production.ntp.users.userUpdated | |
production.ntp.users.userDeleted | |
development.ntp.social.commentCreated | |
development.ntp.social.commentDeleted | |
development.ntp.social.liked | |
development.ntp.social.unliked | |
development.ntp.social.ecardSent | |
development.ntp.social.ecardReceived | |
development.ntp.social.nominationCreated | |
development.ntp.social.nominationApproved | |
development.ntp.social.nominationDeclined | |
development.ntp.social.nominationReceived | |
stage.ca.yearbook.invitationSent | |
stage.ca.yearbook.invitationReceived | |
## Envelope Structure | |
Messages are send in an envelope so they can be quickly filtered by time, version and other attributes relevant to all messages | |
{ | |
version: 1.0.1 | |
timestamp: YYYY-MM-DD-HH-MM-SS-MS | |
appName: "give-api" | |
appVersion: 0.0.2 | |
message: <the message> | |
} | |
## Message Structure | |
Messages are simple hashmaps | |
{ | |
} | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment