Core Concepts

Workspaces

Understand how HookMessage scopes senders, API keys, messages, contacts, billing, and team access.

What belongs to a workspace

Every sender, API client, message, webhook, contact, segment, template, campaign, automation rule, team member, billing subscription, and audit log belongs to one workspace.

Dashboard users operate inside their current workspace. API keys are also workspace-scoped, so a key cannot send through senders from another workspace.

How integrations use workspace data

Your backend usually does not pass a workspace ID when sending messages. The API derives the workspace from the `x-api-key` header and validates sender access from that key.

To find the sender IDs available to an integration, call `GET /api/senders` with the same API key the integration will use for sending.

GET/api/senders

List senders assigned to the API key's workspace and client.

Parameter	Type	Description
`x-api-key`required	header	Customer API key created in the dashboard.

200 response

json

[
  {
    "sender_id": "9f4b5d4c-0000-4000-9000-123456789abc",
    "workspace_id": "f2aa1d49-9f4b-4f37-9918-d8d8f13fb530",
    "phone_number": "212612345678",
    "display_name": "Main support",
    "status": "connected",
    "is_active": true
  }
]

Operational checklist

Before going live, confirm the workspace has an active plan, at least one connected sender, a server-side API key, and webhook or polling behavior for delivery status.

When multiple teams use the same workspace, rotate old API keys and keep sender assignments narrow so each integration only reaches the numbers it needs.

Need help?

Use Book Integration Help if you want setup help for OTP or automated customer messaging.

Next steps

Quickstart

A practical path from empty workspace to a working server-side integration.

Authentication and access

HookMessage separates customer API keys, dashboard sessions, and internal platform access.

Senders and sessions

A sender is the WhatsApp number used to deliver messages for a workspace.

Send customer messages

Use `/api/messages/send` for opted-in, application-triggered customer communication.