Welcome! :) # Examples repositories - [Golang cli example application](https://github.com/super-simple-whats/go-cli-app) - [Python Langchain agent](https://github.com/super-simple-whats/langchain-agent) # Base URL [https://super-simple-whatsapp.p.rapidapi.com/](https://super-simple-whatsapp.p.rapidapi.com/) # Getting Started ## First request Use the `register_device` or the `render_qrcode_device_registration` endpoint to register your device. It will return a HTML with a PNG image (in case of render_qrcode_device_registration) or a string to be rendered into a qrCode (in case of register_device). Now use the WhatsApp or WhatsApp Business app in your device to read and authenticate. **🥳 Congratulations**! 🎉 Now you already have one device connected and can send other requests, like: - List conversations from device (`conversations/list`) - List messages from conversations (`conversations/list_messages`) - Send message (`messages/send`) You will use this registered device to interact with the WhatsApp web API through SuperSimpleWhats. ### 😎 Yes, it is THIS SIMPLE. # Hooks Your application can receive real-time updates by listening to hook events sent by our system. These events notify you about various states or actions related to your connected device. ## Hook event structure Each hook event is a JSON object with the following structure: ``` json { "device_name": "", "event_name": "", "data": {} } ``` | Property | **Type** | Description | | --- | --- | --- | | device_name | string | The identificator (name/key) of the device related to the event. | | event_name | string | The following event_name values may be sent:

qr_code: A new QR code is available for login.

logout: The device has been logged out.

message_sent: A message was successfully sent from the device.

logged_in: The device has logged in successfully.

message_received: A new incoming message was received by the device. | | data | any | The content of the event. | ### **Setting Up a Listener** To receive these events, you must expose an HTTP endpoint that accepts POST requests with the event payload. We recommend using one of the following tools during development: #### **Option 1: Ngrok** [Ngrok](https://ngrok.com/) allows you to expose your local server to the internet securely. Example: ``` bash ngrok http 3000 ``` Then set your webhook URL in our system to the forwarded address shown by ngrok (e.g., [https://abc123.ngrok.io/hook](https://abc123.ngrok.io/hook)). #### **Option 2: RequestBin** [RequestBin](https://requestbin.com/) lets you inspect incoming HTTP requests easily. It’s ideal for testing the format and delivery of hook events. 1. Create a bin on RequestBin. 2. Use the generated URL as your webhook endpoint. 3. View incoming event payloads in real time.