Skip to content

Connect WhatsApp

Meta signup status

Returns whether the guided Meta signup is available on this server and how far the workspace has got. The signup itself runs in the app, in a Facebook pop-up.

GET/api/v1/onboarding/status
  • Bearer API key
  • Scope: read or write
  • or app session
  • Workspace: X-Tenant-ID (optional with a key)

Headers

  • Authorizationstringrequired

    Your API key as Bearer <key>. The word Bearer and the space are case-sensitive. Browser clients signed in to the app use the session cookie instead.

    Constraints
    Keys start with pk_live_ and are 56 characters long.
    Example
    Bearer pk_live_…
  • X-Tenant-IDuuidoptional

    Workspace id. Optional with an API key (a key always acts in its own workspace); if you send it, it must match the key’s workspace. Required with a session cookie. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • availableboolean

    true when the guided signup is configured on this server.

  • missingarray<string>

    Server settings that are missing, when not available.

  • configuredboolean

    true when a Cloud API number is saved for the workspace.

  • readyboolean

    true once the number is fully set up.

  • phasestring

    Current step: not_connected, manual_credentials_saved, authorizing, authorized, subscribed or connected.

  • callback_urlstring

    Callback URL to give Meta: /api/webhooks/meta when the webhook is managed for you, otherwise /api/webhooks/meta/<workspace_id>.

  • webhook_managedboolean

    Whether whatsappx.si manages the Meta webhook.

Status codes

  • 200OK. Signup state.
  • 401Unauthorized. The API key is unknown, revoked or expired (invalid or expired API key), or there is no key and no signed-in session (unauthorized).
  • 402Payment required. Only when subscriptions are enforced and the workspace has no active subscription. The body includes code: "payment_required".
  • 403Forbidden. The X-Tenant-ID header or tenant query does not match the API key’s workspace (API key belongs to a different workspace), or a signed-in user is not a member of the workspace (forbidden).
  • 500Server error. The status could not be loaded.

The response also contains settings the app needs to open the Facebook pop-up (app_id, config_id, api_version, signup_version) and a few fixed values (webhook_received, live_send, coexistence_supported, local_connection_available, local_phone). Do not rely on fields that are not listed above.

Which endpoints run the guided signup?

The steps run in the app while an owner or admin is signed in, so they are Console only: POST /api/v1/onboarding/start (returns a state), /exchange ({state, code} from the Facebook pop-up), /complete ({state, waba_id, phone_id, pin}), /activate and /set-pin ({pin}, six digits) and /reset. They are not meant to be called from integrations.