Glossary
Plain-language definitions for the names used in the dashboard, API responses, and integration guides.
Account and access
These terms explain who owns resources and how an application is allowed to call HookMessage.
- Workspacethe private container for one customer’s API keys, senders, messages, usage, team, and billing.
- API key or API clienta secret beginning with `was_` that identifies a server integration and limits what it may do.
- Rolethe permission attached to an API key. Use `otp` for OTP requests and `send_message` for custom messages.
- Dashboard sessionthe secure browser login used to manage a workspace. It is not an API key.
Numbers and routing
A sender is the WhatsApp number that sends. A receiver is the customer number that receives.
- Managed sendera HookMessage-controlled number selected automatically for eligible Sandbox or platform-routed requests.
- Connected sendera WhatsApp number linked by QR code and controlled by the workspace.
- sender_idthe UUID of a connected sender. Omit it for Free Sandbox; include it when a paid integration must use a specific connected number.
- receiver_numberthe destination number in international digits, without spaces or a local leading zero.
Messages and delivery
Sending is asynchronous. The API accepts work first and delivery happens afterward.
- message_idthe unique ID returned by a successful send request. Save it for status checks and support.
- queuedHookMessage accepted the request and stored it for processing.
- processinga worker is attempting delivery.
- sentthe sender service accepted the message.
- faileddelivery stopped. Inspect the message status and `error_message`.
- Webhooka signed HTTPS request sent to your server when an event occurs.
- Idempotency keya unique value supplied by your application to prevent an accidental duplicate send during retries.
Plans and usage
Plan limits are enforced by the backend, not only by disabled dashboard buttons.
- Sandbox credita limited test unit used by the managed Free Sandbox flow.
- Monthly message limitthe number of billable messages allowed in the current subscription period.
- Sender limitthe maximum number of customer-owned WhatsApp numbers that the workspace may connect.
- Rate limita short-term request-speed limit used to protect the API. It is different from the monthly plan limit.
Need help?
Use Book Integration Help if you want setup help for OTP or automated customer messaging.
Continue building
Next steps
Start here
A plain-language map of Free Sandbox, paid sender modes, credentials, and the first successful request.
Free Sandbox quickstart
The shortest beginner path from a verified account to a queued Free Sandbox OTP.
Authentication and access
HookMessage separates customer API keys, dashboard sessions, and internal platform access.
Workspaces
A workspace is the tenant boundary for every customer resource.