Skip to content

Playbooks

Playbooks are standard operating procedures (SOPs) for UCP. Use calls.md for payload shape and required fields.

Surface availability (explicit)

  • API Gateway: Available.
  • Direct Lambda: Not offered.
  • CLI: Not available.
  • MCP: Available.

Onboarding a platform

  1. Admin registers platform: POST /ucp/platform/register with caption and scopes.
  2. Admin records client_id and client_secret — secret is shown once only.
  3. Platform uses client_id/client_secret for checkout operations.
  4. Admin can rotate secret (/platform/rotate) or revoke (/platform/revoke).

Checkout flow (platform)

  1. Platform creates session: POST /ucp/checkout/create with line_items and optional buyer.
  2. Platform updates session as needed: POST /ucp/checkout/update.
  3. When session is ready_for_complete, platform finalizes: POST /ucp/checkout/complete.
  4. On success, SCM order is created and scm_order_guid is returned.
  5. On failure, session reverts to ready_for_complete with error_message.