Webhook events

On this page you will find the different types of events that Rankbid can send to your webhook URL.

Name
auction_started
Description
Sent when an auction that was previously created has started. The payload contains a single attribute auction.

Example payload for auction_started

{
    "eventType": "auction_started",
    "payload": {
        "auction": {
            "auctionId": "5119f4a6-2598-4229-9c36-658ac60eb5a3",
            "title": "Website homepage visibility spot auction",
            "createdAt": "2024-09-10T00:00:00+00:00",
            "biddingPeriodStartsAt": "2024-09-10T00:00:23.456+00:00",
            "biddingPeriodEndsAt": "2024-09-11T00:00:00+00:00",
            "minimumBidValueInCents": 14000,
            "type": "asynchronous",
            "status": "ongoing",
            "auctionUrl": "https://www.rankbid.io/auctions/5119f4a6-2598-4229-9c36-658ac60eb5a3"
        }
    }
}

Name
auction_completed
Description
Sent when an auction has ended. The payload contains the auction and the winningBid that won the auction. The winning bid is usually the bid with the highest value that was placed before the bidding period ended. In some rare cases, the payment for the winning bid cannot be captured, and so Rankbid captures the payment for the next highest bid instead, which will correspond to the winningBid property if it happens. If there are no winning bids, the winningBid property will be null.

Example payload for auction_completed

{
    "eventType": "auction_completed",
    "payload": {
        "auction": {
            "auctionId": "5119f4a6-2598-4229-9c36-658ac60eb5a3",
            "title": "Website homepage visibility spot auction",
            "createdAt": "2024-09-10T00:00:00Z",
            "biddingPeriodStartsAt": "2024-09-10T08:00:15+00:00",
            "biddingPeriodEndsAt": "2024-09-11T10:00:00+00:00",
            "minimumBidValueInCents": 14000,
            "type": "asynchronous",
            "status": "completed",
            "auctionUrl": "https://www.rankbid.io/auctions/5119f4a6-2598-4229-9c36-658ac60eb5a3"
        },
        "winningBid": {
            "bidId": "08b3ee37-fb5c-4993-824f-149370ebb320",
            "auctionId": "5119f4a6-2598-4229-9c36-658ac60eb5a3",
            "bidderId": "bidder@example.com",
            "bidValueInCents": 15490,
            "placedAt": "2024-09-11T09:47:56+00:00",
            "isWinningBid": true
        }
    }
}

Name
bid_placed
Description
Sent whenever a bid is placed on an auction. The payload contains the bid that was placed.

Example payload for bid_placed

{
    "eventType": "bid_placed",
    "payload": {
        "bid": {
            "bidId": "08b3ee37-fb5c-4993-824f-149370ebb320",
            "auctionId": "5119f4a6-2598-4229-9c36-658ac60eb5a3",
            "bidderId": "bidder@example.com",
            "bidValueInCents": 15490,
            "placedAt": "2024-09-11T09:47:55.472+00:00",
            "isWinningBid": false
        }
    }
}