Skip to main content
GET
/
{instance}
/
health
Check Instance Health
curl --request GET \
  --url https://app.hypersender.com/api/whatsapp/v1/{instance}/health \
  --header 'Authorization: Bearer <token>'
{
  "instance_id": "fa3d01c4-1234-4c0d-a12f-df319b612f8c",
  "connected_at": "2025-05-26T10:12:45",
  "status": "WORKING"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt

Use this file to discover all available pages before exploring further.

Check the current health status and connection state of your WhatsApp instance using its UUID.

​
Rate Limit

This endpoint is limited to 10 requests per minute to prevent abuse and ensure system stability.

​
Response Fields

  • instance_id - The UUID of your WhatsApp instance
  • connected_at - Timestamp when the instance was connected
  • status - Current status of the instance

​
Instance Status Values

  • STOPPED: Instance is stopped
  • STARTING: Instance is starting up
  • WORKING: Instance is running and ready to use
  • SCAN_QR_CODE: Waiting for QR code to be scanned
  • FAILED: Instance failed to start
  • PENDING: Awaiting server assignment

​
Use Cases

  • Monitor instance health in your dashboard
  • Verify instance is ready before sending messages
  • Troubleshoot connection issues
  • Automated health checks in monitoring systems
Check the instance health before attempting to send messages to ensure the instance is in WORKING status.

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Example: Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1

Headers

​
Accept
string

application/json

Example:

"application/json"

Path Parameters

​
instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Response

Successful response

​
instance_id
string
Example:

"fa3d01c4-1234-4c0d-a12f-df319b612f8c"

​
connected_at
string
Example:

"2025-05-26T10:12:45"

​
status
enum<string>

Instance status:

  • STOPPED: Instance is stopped
  • STARTING: Instance is starting
  • WORKING: Instance is running and ready
  • SCAN_QR_CODE: Waiting for QR code to be scanned
  • FAILED: Instance failed to start
  • PENDING: Awaiting server assignment
Available options:
STOPPED,
STARTING,
WORKING,
SCAN_QR_CODE,
FAILED,
PENDING
Example:

"WORKING"