To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fired whenever a bid is processed on an auction, covering both a brand new bid and a change in who is leading. Raised from the auction bidding logic in AuctionApp for three cases: the bidder who now holds the leading bid places their first bid for this auction (BID_PLACED), a previously leading bidder is overtaken by someone else (OUTBID), or a previously leading bidder is overtaken by their own higher bid (SELF_OUTBID). The source profile is the profile the action happened to, not necessarily the bidder who caused it. Event ID: auctionBid.
Group: Journeys
Implements: TriggerEvent, FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| action | AuctionBidAction | Which of the three bidding outcomes this event represents. |
| attributes | Map<String,Object> | Extra properties for this event: "bid" (the auction bid), "previousBid" (when there was one) and "auction". |
| auctionBid | AuctionBid | The bid this event is about. For OUTBID and SELF_OUTBID this is the new leading bid that overtook the previous one; for BID_PLACED it is the bidder's first bid on the auction. |
| auctionTitle | String | Convenience accessor for the title of the auction this bid was placed on. |
| eventId | String | The constant event id used to register listeners for this event type. |
| leadProfile | Profile | The profile that placed the bid this event is about. |
| previousAuctionBid | AuctionBid | The bid that was leading before this one, or null if there was no previous leading bid (eg the first bid ever placed on the auction). |
| relatedLead | Lead | This event is never associated with an existing lead. |
| sourceProfile | Profile | The profile the bidding outcome happened to: the outbid bidder for OUTBID and SELF_OUTBID, or the bidder themselves for BID_PLACED. |
| triggerItem1 | String | The id of the website the auction belongs to. |
| triggerItem2 | String | The name of the bid action - "BID_PLACED", "OUTBID" or "SELF_OUTBID". |
| triggerItem3 | String | Not used, always null. |
| triggerItem4 | String | Not used, always null. |
| triggerItem5 | String | Not used, always null. |
| website | Website | The website the auction belongs to. |
Inherited from TriggerEvent
Properties
| Property | Returns | Description |
|---|---|---|
| serialisable | 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
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
getAuctionBid() · getPreviousAuctionBid() · getAuctionTitle() · getAction() · getEventId() · getWebsite() · getSourceProfile() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAttributes() · getLeadProfile() · getRelatedLead()
getAuctionBid()
Returns: AuctionBid
The bid this event is about. For OUTBID and SELF_OUTBID this is the new leading bid that overtook the previous one; for BID_PLACED it is the bidder's first bid on the auction.
getPreviousAuctionBid()
Returns: AuctionBid
The bid that was leading before this one, or null if there was no previous leading bid (eg the first bid ever placed on the auction).
getAuctionTitle()
Returns: String
Convenience accessor for the title of the auction this bid was placed on.
getAction()
Returns: AuctionBidAction
Which of the three bidding outcomes this event represents.
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 the bidding outcome happened to: the outbid bidder for OUTBID and SELF_OUTBID, or the bidder themselves for BID_PLACED.
getTriggerItem1()
Returns: String
The id of the website the auction belongs to.
getTriggerItem2()
Returns: String
The name of the bid action - "BID_PLACED", "OUTBID" or "SELF_OUTBID".
getTriggerItem3()
Returns: String
Not used, always null.
getTriggerItem4()
Returns: String
Not used, always null.
getTriggerItem5()
Returns: String
Not used, always null.
getAttributes()
Returns: Map<String,Object>
Extra properties for this event: "bid" (the auction bid), "previousBid" (when there was one) and "auction".
getLeadProfile()
Returns: Profile
The profile that placed the bid this event is about.
getRelatedLead()
Returns: Lead
This event is never associated with an existing lead.
© 2025 Kademi Ltd