ZenBid Docs

Quickstart

Make an existing business website agent-ready, then add gated bid and buy flows through ZenBid.

Quickstart

ZenBid makes an existing business website agent-ready. Business owners create listings in ZenBid, install one page-specific snippet on their homepage or service pages, and let agents discover a trusted manifest before attempting gated bid or buy actions.

The launch product supports two listing types:

  • agent_service
  • calendar_slot

What Ships In Beta

  • agent-ready page snippets for existing websites
  • public manifests for installed pages
  • seller verification gates public marketplace visibility
  • buyers can buy now or negotiate through first-class offers
  • orders add a 10% platform fee to subtotal
  • Stripe powers checkout while payout release stays manually reviewed
  1. Create an organization from the console or a signed-in session.
  2. Complete the organization profile and submit verification.
  3. Create and publish a listing.
  4. Open Console -> Install and generate a page snippet.
  5. Paste the snippet into the matching website page.
  6. Verify the installation.
  7. Add API keys and webhooks only when you need server-to-server automation.

Step 1: Create The Seller Shell

Human-owned setup routes:

  • POST /api/v1/organizations
  • POST /api/v1/auth/api-keys
  • GET /api/v1/auth/session

ZenBid keeps one active organization in focus at a time for console and organization-authenticated API workflows. Create the organization first, then create the listing and install snippet that agents will discover.

Step 2: Create A Listing

curl https://zenbid.ai/api/v1/listings \
  -X POST \
  -H 'Authorization: Bearer zb_live_xxxxx.yyyyy' \
  -H 'Content-Type: application/json' \
  -d '{
    "listingType": "agent_service",
    "title": "Inbox Triage Agent Setup",
    "slug": "inbox-triage-agent-setup",
    "summary": "Production-ready inbox triage workflow with audit logs and escalation paths.",
    "description": "We configure an inbox triage agent with routing policies, review queues, webhook callbacks, and operator handoff rules for your support or operations team.",
    "category": "automation",
    "tags": ["automation", "ops", "email"],
    "status": "draft",
    "pricingModel": "fixed_or_offer",
    "currency": "USD",
    "minimumOffer": 1800,
    "buyNowPrice": 2500,
    "fulfillmentType": "async_delivery",
    "fulfillmentWindowText": "Delivered within 72 hours",
    "deliverables": ["workflow spec", "handoff rules", "deployment checklist"],
    "turnaroundHours": 72,
    "revisionPolicy": "One revision included",
    "serviceLevels": [
      {
        "name": "Launch package",
        "description": "Workflow setup, QA pass, and operator handoff"
      }
    ]
  }'

Publish the listing with POST /api/v1/listings/:id/publish after the payload is ready.

Step 3: Install On The Website

Open Console -> Install, choose the website page URL, attach the listing, and copy the generated snippet.

<script
  async
  src="https://zenbid.ai/agent-ready.js"
  data-zenbid-install="zbi_example_token"
></script>

The snippet injects a manifest link and structured metadata into the page. It does not contain private credentials. See Install ZenBid for generic and WordPress instructions.

Step 4: Negotiate Or Buy Now

  • Use POST /api/v1/offers for offer_only or fixed_or_offer listings.
  • Use POST /api/v1/orders for direct checkout on a fixed_price listing.
  • Use POST /api/v1/orders with an accepted offerId when the commercial terms were negotiated first.

Bid and buy actions are intentionally gated. Agents can discover public listing metadata from the installed page, but transaction routes require ZenBid credentials tied to a buyer organization.

Step 5: Collect Payment

POST /api/v1/payments/create-intent returns a payment record and, in Stripe mode, a hosted checkoutUrl. In local mock mode it can immediately mark the order as paid so development flows do not stall on processor setup.

Step 6: Close The Loop With Webhooks

Register an endpoint with POST /api/v1/webhooks/endpoints. ZenBid signs each delivery and stores delivery attempts so beta operators can inspect failures without reverse-engineering logs.

Keep Going

Install ZenBid

Make an existing website page discoverable to agents with one ZenBid snippet.

On this page

QuickstartWhat Ships In BetaRecommended Launch FlowStep 1: Create The Seller ShellStep 2: Create A ListingStep 3: Install On The WebsiteStep 4: Negotiate Or Buy NowStep 5: Collect PaymentStep 6: Close The Loop With WebhooksKeep Going