API Events

This document explains the event model which is used by API functions.

Event basics

Events are notifications about important changes in the marketplace, that may be of potential interest to the user. Events can describe such changes as receiving a bid in an auction, rejecting a domain purchase offer, and so on. Thanks to the event mechanism, the API user can quickly learn about new events that took place on their account.

New events are returned by the getNewEvents() function. It returns a list (of specified length) of new events, starting with the oldest ones. The optional "type" parameter can be used to retrieve only specific events (see the table below). Two catch-all pseudo-types are also defined, to allow retrieving all events received as the buyer or as the seller.

Events are returned in the Event object, which contains information about the event type, domain name which is related to the event, domain price, and related object identifier. This identifier describes the object that was created or modified during the event (it can be the acution object, offer object and so on).

After retrieving and processing the events, it is necessary to notify the API server with clearEvents() function. This function marks the events as read, so that new events can be retrieved.

Event table

The following event types are currently used in the API.

AfterMarket.pl API events
Type	Recipient	Meaning	Object ID
BUYER	Buyer	Catch-all filter for all buyer events.
SELLER	Seller	Catch-all filter for all seller events.
auctionCanceled	Seller	An active (running) auction has been canceled.	Auction ID
auctionDeleted	Seller	An auction has been removed prior to being listed.	Auction ID
auctionFinishedWithBids	Seller	An auction has finished with at least one bid.	Auction ID
auctionFinishedWithoutBids	Seller	An auction has finished without any bids.	Auction ID
auctionHidden	Seller	An auction has been removed from the finished auction list.	Auction ID
auctionPromoted	Seller	Auction promotion has been purchased.	Auction ID
auctionStarted	Seller	A new auction has been started in the marketplace.	Auction ID
auctionWon	Buyer	An auction has finished, and your bid has been the highest.	Auction ID
bidPlaced	Buyer	A new bid has been placed in an auction.	Auction ID
bidReceived	Seller	A new bid has been placed in an auction.	Auction ID
counterOfferMade	Seller	A counteroffer has been made for a domain.	Counteroffer ID
counterOfferReceived	Buyer	A counteroffer has been received for a domain.	Counteroffer ID
domainBought	Buyer	A Buy It Now option has been used for a domain.
domainInAuction	Buyer	The domain is available on a marketplace auction.	Auction ID
domainNotPaid	Buyer	Payment has not been submitted on time for a domain.
domainNotSold	Seller	A purchased domain has not been paid by the buyer.
domainPendingPayment	Buyer	Payment is required for a purchased domain.
domainPendingSale	Seller	A domain has been sold on the marketplace and is pending payment from the buyer.
domainRegistered	Buyer	A new domain has been registered on user account.
domainSold	Seller	A domain has been successfully sold on the marketplace.
escrowClosed	Buyer	An Escrow transaction has been successfully finished.	Escrow ID
escrowFinished	Seller	An Escrow transaction has been successfully finished.	Escrow ID
escrowNotFinished	Seller	An Escrow transaction has not been finished fue to domain non-transfer by the seller.	Escrow ID
escrowTimeout	Buyer	An Escrow transaction has not been finished fue to domain non-transfer by the seller.	Escrow ID
offerAccepted	Buyer	A domain purchase offer has been accepted.	Offer ID
offerMade	Buyer	A new domain purchase offer has been made.	Offer ID
offerReceived	Seller	A new domain purchase offer has been received.	Offer ID
offerRejected	Buyer	A domain purchase offer has been rejected.	Offer ID
offerToAuction	Buyer	A domain purchase offer has been accepted by starting an auction.	Offer ID
receivedOfferAccepted	Seller	A domain purchase offer has been accepted.	Offer ID
receivedOfferRejected	Seller	A domain purchase offer has been rejected.	Offer ID
receivedOfferToAuction	Seller	A domain purchase offer has been accepted by starting an auction.	Offer ID

	AfterMarket

[ class tree: AfterMarket ] [ index: AfterMarket ] [ all elements ]