REST API and realtime integration

At a glance

Audience: Developer / integrator. Difficulty: advanced. Time: about 30 minutes.

Prerequisites

WordPress REST familiarity
Authenticated session for writes

Steps

1. Use the namespace

All routes live under /wp-json/canvas-auctions/v1/.

2. Authenticate writes

Send cookie auth plus a valid REST nonce for POST routes.

3. Poll events by sequence

Live clients call GET /auctions/{id}/events incrementally. Recover from last confirmed sequence after reconnect.

4. Never trust push alone

If a push transport is configured, treat it as a wake signal only. Authoritative state always comes from WordPress.

REST routes

Namespace: canvas-auctions/v1 (full path /wp-json/canvas-auctions/v1).

Methods	Path
GET, POST	`/auctions`
GET	`/auctions/\{id\}`
GET	`/auctions/\{id\}/state`
GET, POST	`/auctions/\{id\}/bids`
GET	`/auctions/\{id\}/events`
POST	`/auctions/\{id\}/watch`
POST	`/auctions/\{id\}/submit`
POST	`/auctions/\{id\}/approve`
POST	`/media`
POST	`/live/\{id\}/host`
POST	`/live/\{id\}/join`
POST	`/awards/\{id\}/checkout`
GET	`/products`
GET	`/products/\{id\}`
POST	`/holder/apply`
GET	`/me/dashboard`
POST	`/auctions/\{id\}/accept-bid`
POST	`/orders/\{id\}`
GET, POST	`/payouts`
POST	`/payouts/method`
POST	`/payouts/\{id\}/cancel`

Actions

wcap_auction_created
wcap_auction_approved
wcap_auction_started
wcap_before_bid_validation
wcap_bid_accepted
wcap_bidder_outbid
wcap_auction_extended
wcap_auction_closed
wcap_award_created
wcap_winner_checkout_initialized
wcap_order_linked
wcap_payment_completed
wcap_payment_failed
wcap_payment_deadline_expired
wcap_settlement_calculated
wcap_payout_status_changed
wcap_notification_dispatch
wcap_realtime_notify
wcap_holder_approved
wcap_holder_rejected
wcap_logged

Filters

wcap_bid_increment
wcap_commission_amount
wcap_public_bidder_display_name
wcap_role_restricted_access
wcap_enqueue_frontend_assets
wcap_user_can_access_wp_admin
wcap_dashboard_url_for_user
wcap_login_redirect
wcap_allow_frontend_registration
wcap_max_image_bytes
wcap_image_uploads_per_hour

WP-CLI

wp canvas-auctions list [--state=<state>]
wp canvas-auctions close <id>
wp canvas-auctions overdue
wp canvas-auctions rebuild <id>
wp canvas-auctions schema
wp canvas-auctions diagnostics
wp canvas-auctions reschedule <id>
wp canvas-auctions migrate

REST API and realtime integration

On this page