Fired when an auction closes, once for the outcome and again for every bidder who did not win. AuctionApp fires CLOSED_WITH_WINNER (source profile is the winner) or CLOSED_WITHOUT_WINNER (no valid bids) at the moment the auction is closed. Separately, AuctionClosedProcessable runs as a background job afterwards and fires one CLOSED_BIDDER event per profile who placed a bid but did not win.

Group: Journeys

Implements: TriggerEvent, FunnelEvent


Properties

PropertyReturnsDescription
actionAuctionClosedActionWhich of the three closed outcomes this event represents.
attributesMap<String,Object>Extra properties for this event: "winningBid" when the action is CLOSED_WITH_WINNER, and "auction" always.
eventIdStringThe constant event id used to register listeners for this event type.
leadProfileProfileThe profile this event concerns, or null for CLOSED_WITHOUT_WINNER.
relatedLeadLeadThis event is never associated with an existing lead.
sourceProfileProfileThe profile this event concerns: the winner for CLOSED_WITH_WINNER, null for CLOSED_WITHOUT_WINNER, or the non-winning bidder for CLOSED_BIDDER.
triggerItem1StringThe id of the website the auction belongs to.
triggerItem2StringThe title of the auction that closed.
triggerItem3StringThe name of the closed action - "CLOSED_WITH_WINNER", "CLOSED_WITHOUT_WINNER" or "CLOSED_BIDDER".
triggerItem4StringNot used, always null.
triggerItem5StringNot used, always null.
websiteWebsiteThe website the auction belongs to.

Inherited from TriggerEvent

Properties

PropertyReturnsDescription
serialisablebooleanWhether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.

Methods

isSerialisable()

Returns: boolean

Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.


Methods

toProps() · getEventId() · getWebsite() · getSourceProfile() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAction() · getAttributes() · getLeadProfile() · getRelatedLead()

toProps()

Returns: Map<String,Serializable>

Builds the serialisable properties for this event: a URN pointing at the auction, and the closed action ("CLOSED_WITH_WINNER", "CLOSED_WITHOUT_WINNER" or "CLOSED_BIDDER") as a plain string property.

getEventId()

Returns: String

The constant event id used to register listeners for this event type.

getWebsite()

Returns: Website

The website the auction belongs to.

getSourceProfile()

Returns: Profile

The profile this event concerns: the winner for CLOSED_WITH_WINNER, null for CLOSED_WITHOUT_WINNER, or the non-winning bidder for CLOSED_BIDDER.

getTriggerItem1()

Returns: String

The id of the website the auction belongs to.

getTriggerItem2()

Returns: String

The title of the auction that closed.

getTriggerItem3()

Returns: String

The name of the closed action - "CLOSED_WITH_WINNER", "CLOSED_WITHOUT_WINNER" or "CLOSED_BIDDER".

getTriggerItem4()

Returns: String

Not used, always null.

getTriggerItem5()

Returns: String

Not used, always null.

getAction()

Returns: AuctionClosedAction

Which of the three closed outcomes this event represents.

getAttributes()

Returns: Map<String,Object>

Extra properties for this event: "winningBid" when the action is CLOSED_WITH_WINNER, and "auction" always.

getLeadProfile()

Returns: Profile

The profile this event concerns, or null for CLOSED_WITHOUT_WINNER.

getRelatedLead()

Returns: Lead

This event is never associated with an existing lead.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.