hub WhatsApp Gateway
Sign In View Docs

On-Site Documentation

Connect Instance

Use an app-created instance, request QR or pairing flow, and confirm the WhatsApp session reaches open state.

Download PDF Overview Quickstart Connect Instance Send Messages Receive Webhooks Responsible Messaging 3CX Overview 3CX Webhooks 3CX Call Events 3CX Troubleshooting n8n Integration Endpoint Map OpenAPI SDK Overview PHP Examples Node.js Examples Python Examples Postman Collection Troubleshooting

Connect

Instance Connection Workflow

Run this sequence exactly to avoid partial setup states.

1. Ensure Instance Exists In App

Instance creation is app-only. Use this internal flow:

Dashboard > Instances > Create Instance

2. Request QR Code

Dashboard > Instances > Manage > Connection > Connect

Use this for the standard QR scan flow from a mobile device.

3. Optional Pairing Code Flow

Dashboard > Instances > Manage > Connection > Connect with phone number

Use only when pairing-by-number is enabled in your WhatsApp Gateway setup.

4. Poll Connection State

Dashboard > Instances > Manage > Connection

Repeat until state becomes open. If it stays closed, restart session and retry QR.

Portal UI Path

  • Open /instances and create/select an instance.
  • Open /instances/{id}/manage.
  • Use Connect action for QR request.
  • Monitor status card until connection is open.

If Connection Fails

  • Verify your customer API key is active and sent as Authorization: Bearer.
  • Verify instance name in URL path matches the app-created instance.
  • Check web server routing does not rewrite the documented WhatsApp Gateway routes.
  • Open troubleshooting guide for timeout and auth cases.
Open Troubleshooting