Playoff Events

The Playoff platform emits special objects called events on special occasions, such as when a player triggers an action, or unlocks an achievement. These events are then collected up and shown in activity logs, player notifications, and other places.

What follows is a complete list of events on the Playoff Platform.

Create

create

Triggers on
  • Creating a Team
  • Creating a Process
Logged In
  • Game activity log
  • Player's activity log
Fields
NameDescription
event

Name of the event: create

timestamp

ISO timestamp of the event

process/team

Object with id and name of the newly created team/process.

actor

Object with id and name of the player who created the team/process.

Delete

delete

Triggers on
  • Deleting a Team
  • Deleting a Process
Logged In
  • Game activity log
  • Actor's activity log
  • Notification streams of all team members/process performers
Fields
NameDescription
event

Name of the event: delete

timestamp

ISO timestamp of the event.

process/team

Object with id and name of the deleted team/process.

actor

Object with id and name of the player who performed the action.

Join

join

Triggers on
  • Joining a Team
  • Joining a Process
Logged In
  • Player's activity log
  • Team's/Process's activity log
  • Notification streams of all team members/process performers
Fields
NameDescription
event

Name of the event: join

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process which the player joined.

roles

Roles with which the player joined the team/process.

player

Object with id and name of the player who joined the team/process.

Join Request

join:request

Triggers on
  • Joining a Protected Team
  • Joining a Protected Process
Logged In
  • Notification streams of all team members/process performers who can approve this request
Fields
NameDescription
event

Name of the event: join:request

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process to which access has been requested.

roles

The roles in the team/process requested by the player.

state

The state of the request. Should be PENDING.

player

Object with id and alias of the player who made the join request.

Leave

leave

Triggers on
  • Leaving a Team
  • Leaving a Process
Logged In
  • Player's activity log
  • Team's/Process's activity log
  • Notification streams of all team members/process performers
Fields
NameDescription
event

Name of the event: leave

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process.

actor

Object with id and alias of the player who performed this action.

Role Change

role:change

Triggers on
  • Changing Own Roles in a Team
  • Changing Own Roles in a Process
Logged In
  • Notification streams of all team members/process performers
  • Player's activity log
  • Team's/Process's activity log
Fields
NameDescription
event

Name of the event: role:change.

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process.

roles

Object with the new roles.

Role Request

role:request

Triggers on
  • Requesting a Role Change in Teams Having Sufficient Privileges
  • Requesting a Role Change in Processes Having Sufficient Privileges
Logged In
  • Notification streams of all team members/process performers who can approve the request
Fields
NameDescription
event

Name of the event: role:request .

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process.

state

State of the request. It should be PENDING,

roles

Object with the requested roles.

actor

Object with the id and alias of the player who made the request.

Join Request Accept

join:request:accept

Triggers on
  • Accepting a Team Join Request
  • Accepting a Process Join Request
Logged In
  • Player's activity log
  • Approver's activity log
  • Team's/Process's activity log
  • Notification stream of the requester
  • Notification streams of all team members/process performers
Fields
NameDescription
event

Name of the event: join:request:accept

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process.

player

Object with id and alias of the player whose request was accepted.

actor

Object with id and alias of the player who approved the request.

Role Request Accept

role:request:accept

Triggers on
  • Accepting a Team Member's Request to Change Roles
  • Accepting a Process Performer's Request to Change Roles
Logged In
  • Player's activity log
  • Approver's activity log
  • Notification of the player who made the request
  • Notification streams of all other team members/process performers
Fields
NameDescription
event

Name of the event: role:request:accept

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process.

player

Object with id and alias of the player whose request was accepted.

actor

Object with id and alias of the player who approved the request.

changes

Object with role changes.

Join Request Reject

join:request:reject

Triggers on
  • Rejecting a Team Join Request
  • Rejecting a Process Join Request
Logged In
  • Notification stream of the requesting player
Fields
NameDescription
event

Name of the event: join:request:reject

timestamp

ISO timestamp of the event.

team/process

Object with id and name of the team/process.

roles

roles requested by the player.

actor

Object with id and alias of the player who rejected this request.

Invite

invite

Triggers on
  • Inviting a player to join a team/process
Logged In
  • Notification stream of the invited player
Fields
NameDescription
event

Name of the event : invite

timestamp

ISO timestamp of the event.

invitee

Object with id and alias of the invited player.

team/process

Object with id and name of the team/process.

roles

Roles with which the player was invited to join the team/process.

state

State of the invitation.

actor

Object with id and alias of the player who sent the invite.

Invite Accept

invite:accept

Triggers on
  • Joining a Team via Accepting an Invite
  • Joining a Process via Accepting an Invite
Logged In
  • Notification stream of the player who sent the invite
  • Notification streams of all the team/process members
  • Team's/Process's activity log
  • Invitee's activity log
  • Inviter's activity log
Fields
NameDescription
event

Name of the event: level

timestamp

ISO timestamp of the event.

inviter

Object with id and alias of the player who sent the invite.

team/process

Object with id and name of the team/process to which the player was invited.

roles

Roles in the team/process with which the player was invited.

actor

Object with id and alias of the invited player.

Invite Reject

invite:reject

Triggers on
  • Rejecting an Invite
Logged In
  • Notification stream of the inviter
Fields
NameDescription
event

Name of the event: invite:reject

timestamp

ISO timestamp of the event.

inviter

Object with id and alias of the player who sent the invite.

team/process

Object with id and name of the team/process to which the player was invited.

roles

Roles with which the player was invited.

Progress

progress

Triggers on
  • Playing a process trigger
Logged In
  • Player's activity log
  • Notification stream of the process performer
  • Notification streams of all other performers in the process
Fields
NameDescription
event

Name of the event: progress

process

Object with id and name of the process.

activity

The process activity that was triggered.

timestamp

ISO timestamp of the event.

changes

An array containing the player's score changes.

actor

Object with id and alias of the player who played the trigger.

Resolution

resolution

Triggers on
  • Playing a process trigger
Logged In
  • Deferred Player's activity log
  • Resolving Player's activity log
  • Notification stream of all other performers in the process
Fields
NameDescription
event

Name of the event: resolution

activity

Details of the process activity that was triggered.

deferred

Details of the deferred action.

actor

Object with id and alias of the resolving player.

process

Object with id and name of the process.

Level

level

Triggers on
  • Playing a Process Trigger
  • Playing an Action
  • Executing a Custom Rule
Logged In
  • Notification stream of the player
  • Notification streams of the player's team members
  • Player's activity log
  • Player's Team activity log
  • Process's activity log
  • Game activity log
Fields
NameDescription
event

Name of the event: level

actor

Object with id and alias of the player whose level changed.

changes

Array with object containing details about the level change.

process/action/rule

Details about the process/action/rule that caused the level change.

timestamp

ISO timestamp of the event.

Achievement

achievement

Triggers on
  • Playing a Process Trigger
  • Playing an Action
  • Executing a Custom Rule
Logged In
  • Notification stream of the player
  • Notification streams of the player's team members
  • Player's team activity log
  • Player's activity log
  • Process's activity log
  • Game activity log
Fields
NameDescription
event

Name of the event: achievement

actor

Object with id and alias of the player who unlocked the achievement.

changes

Array with object containing details about the achievement.

process/action/rule

Details about the process/action/rule that caused the level change.

timestamp

ISO timestamp of the event.

Kick

kick

Triggers on
  • Kicking a Member from a Team
  • Kicking a Performer from a Process
Logged In
  • Notification stream of the kicked player
  • Notification streams of all members/performers of their team/process
  • Kicked player's activity log
  • Team's/Process's activity logs
Fields
NameDescription
event

Name of the event: kick

timestamp

ISO timestamp of the event.

player

Object with id and alias of the player who is kicked.

team/process

Object with id and name of the team/process.

actor

Object with id and alias of the player who is performing the kick.

Role Assign

role:assign

Triggers on
  • Updating Roles of a Team Member
  • Updating Roles of a Process Performer
Logged In
  • Notification stream of the assigned player
  • Notification streams of all team members/process performers
  • Player's activity log
  • Team's/Process's activity log
Fields
NameDescription
event

Name of the event: role:assign

timestamp

ISO timestamp of the event.

player

Object with id and alias of the player whose roles are updated.

team/process

Object with id and name of the team/process.

changes

Object that contains details of the role change.

actor

Object with id and alias of the player who performed the role update.

Transfer

transfer

Triggers on
  • Transferring Team Ownership
  • Transferring Process Ownership
Logged In
  • Notification stream of the new owner
  • Notification streams of team members/process performers
  • Team's/Process's activity log
  • New Owner's activity log
  • Old Owner's activity log
Fields
NameDescription
event

Name of the event: transfer

timestamp

ISO timestamp of the event.

new_owner

Object with id and alias of the player to whom the ownership is transferred to.

team/process

Object with id and name of the team/process that is transferred.

changes

The role changes of the new owner.

actor

Object with id and alias of the player who executed the transfer.

Action

action

Triggers on
  • Playing an action
Logged In
  • Player's activity log
  • Notification stream of the player
Fields
NameDescription
event

Name of the event: action

actor

Object with id and alias of the player who played the action.

action

Object with id and name of the action that was executed.

count

The count with which the action was played.

timestamp

ISO timestamp of the event.

Custom Rule

custom:rule

Triggers on
  • Executing a custom rule
Logged In
  • Player's activity log
  • Notification stream of the player
Fields
NameDescription
event

Name of the event: custom_rule

timestamp

ISO timestamp of the event.

rule

Details about the custom rule that was applied.

actor

Player on whom the custom rule was applied.

Score

score

Triggers on
  • Updation a Player's Score by an Admin
Logged In
  • Notification stream of the player
  • Player's activity log
Fields
NameDescription
event

Name of the event: score

timestamp

ISO timestamp of the event.

player

Object with id and alias whose scores have been updated.

changes

Player's score change data.

actor

Details of the admin who made the score changes.