sym.sdk.event.Payload

class sym.sdk.event.Payload(srn: Union[sym.sdk.resource.SRN, str])

Bases: sym.sdk.resource.SymResource

The Payload object contains the data of the Event.

Attributes

actors

A dict mapping Event names to the User that created each Event.

event_name

Returns the name of the Event.

fields

A dict containing the values submitted by the user who created the Event

srn

The SRN of the Event instance.

timestamp

A datetime object indicating when the Event was created.

user

The User who triggered the Event.

property actors

A dict mapping Event names to the User that created each Event. There will be one entry for each Event in the current Run.

For example, with a sym:approval Flow after the “approve” Event is received, the actors may look like this:

{
    "prompt": <User A>,
    "request": <User A>,
    "approve": <User B>
}
property event_name

Returns the name of the Event.

For example, “approve”.

property fields

A dict containing the values submitted by the user who created the Event

property srn

The SRN of the Event instance.

property timestamp

A datetime object indicating when the Event was created.

property user

The User who triggered the Event.