Helium MVNEdocs

Quickstart

Ten minutes, one terminal. You'll accept an invite, mint an API key, create your first subscriber, start a subscription, and receive your first webhook. Everything runs against the sandbox.

Prerequisites

  • An invite from a Helium MVNE super-admin (check your inbox).
  • curl and a shell that supports $(uuidgen).

1. Accept the invite

Click the link in the invite email. You'll land on the Helium MVNE admin dashboard and be prompted to set a password. Once you're signed in, you're an operator admin on your operator's sandbox.

2. Create a sandbox API key

In the dashboard, open Developers → API keys and click Create key. Choose Restricted for this walkthrough and grant subscribers:write, subscriptions:write, and webhooks:read.

Copy the key — it starts with rk_sandbox_. You'll see it exactly once.

export MVNE_KEY=rk_sandbox_...
export MVNE_URL=https://api.mvne.example

3. Create a subscriber

curl $MVNE_URL/v1/subscribers \
-H "Authorization: Bearer $MVNE_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-d email=ada@example.com \
-d name="Ada Lovelace"

The response contains a public_id that starts with sub_.

4. Register a webhook endpoint

Point the platform at an endpoint you control. For the quickstart, webhook.site works fine.

Webhook endpoints are registered from the dashboard, not the API — open Settings → Webhook endpoints in your operator workspace, paste the URL, select subscription.created under enabled events, and save. Copy the signing secret the dashboard shows once (it's not retrievable later), and stash it in your backend's secret store for signature verification.

See Webhooks for HMAC code samples and the full lifecycle.

5. Start a subscription

curl $MVNE_URL/v1/subscriptions \
  -H "Authorization: Bearer $MVNE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d subscriber_id=sub_... \
  -d plan_id=plan_sandbox_basic

Within a few seconds, webhook.site shows a subscription.created event. That's your platform loop end-to-end.

Next steps