Skip to content

Playbooks

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

Surface availability (explicit)

  • API Gateway: Available.
  • Direct Lambda: Not offered.
  • CLI: Available (g3n rbs ..., API Gateway).
  • MCP: Available.

Playbook: Register + verify subscription

Goal: Register a subscription for event delivery and verify queue ownership.

Why this sequence:

  • RBS verifies destination ownership before sending production traffic.
  • Status control allows safe activation and revocation.

Preconditions

  • Target SQS queue exists and is owned/accessible by the subscriber.
  • A valid org session/API key.

SOP (happy path)

  1. Register subscription (POST /subscription/register).
    • Reason: creates the subscription and initiates verification.
  2. Verify subscription (POST /subscription/verify).
    • Reason: confirms queue ownership via token or attribute checks.
  3. Send test delivery (POST /subscription/test).
    • Reason: validates delivery configuration before production.
  4. Update subscription (POST /subscription/update) or status set (POST /subscription/status/set).
    • Reason: adjust filters or pause/resume delivery.
  5. List/get subscriptions (POST /subscription/list, /subscription/get).
    • Reason: audit active subscriptions.
  6. Unregister (POST /subscription/unregister) when no longer needed.
    • Reason: terminates delivery and cleans up.

Outputs

  • Verified subscription delivering events to the target queue.

Failure modes / remediation

  • not-found on verify: ensure the subscription ID is correct.
  • Delivery failures: re-run subscription/test after updating permissions.

Cross-service relationships

  • All services: RBS delivers their events to external queues.