WhatsApp Cloud API Get Started | Developer Documentation
Prepare your first ChatArchitect WhatsApp API integration
Use this guide when a developer will add WhatsApp messaging to your own application through ChatArchitect. It covers the connection decisions, receiver preparation and first controlled checks. Use the ChatArchitect API quick start for the current request examples and field definitions.
For an existing CRM or help desk, begin with the integration-route guide and the setup for your tool. Confirm who manages its callback before adding or changing one.
Prepare the connection and a small test
- A business number connected through the supported ChatArchitect number setup.
- The credentials issued for that connection and a developer responsible for storing and using them on the server.
- A public HTTPS receiver, a verified mapping to the intended connection and an agreed callback contract.
- A permitted test contact, a distinctive test message and the application conversation where the reply should appear.
- A record of existing settings and the supported way to restore them if the test changes an active connection.
Use the credentials and interface in the current guide
The quick start uses https://api.chatarchitect.com as the API base URL and Basic Auth for its API requests:
| Guide notation | Role | Preparation |
|---|---|---|
APP_ID | Basic Auth username for ChatArchitect API requests. | Use the value issued for the intended connection according to the current guide. |
APP_SECRET | Basic Auth password for ChatArchitect API requests. | Keep the value server-side and out of browser code, URLs and public diagnostic records. |
The credentials guide covers App key/Secret in supported setup forms. If the field label or issued value is unclear, confirm it for your connection before sending requests. Review the phone-format rules in the API quick start: its request examples use international digits without a plus sign, spaces or brackets.
Prepare and register the receiver
- Work through the receiver checklist and agree sender verification, callback request method, acknowledgement response/timing and redelivery behavior for the connection.
- Check the public HTTPS route and your event handler. A browser page load and a local synthetic event each establish one part of the preparation.
- Confirm the effect on any existing callback, then follow Step 1 of the quick start to register the intended receiver from your server.
- Keep a redacted registration result and its time with time zone. Continue with an actual permitted connection test to check event receipt.
The quick start documents JSON events and safe duplicate processing but leaves several transport details unspecified. API Basic Auth describes the registration request; agree the incoming callback's verification requirements separately. The staged receiver test explains how to distinguish local handling, public routing and observed message events.
Use the three documented API operations
| Operation | Purpose in the quick start | Record to inspect |
|---|---|---|
POST /webhook | Register the HTTPS receiver for delivery results and incoming messages. | Registration response, intended connection and receiver URL. |
POST /whatsappmessage | Send ordinary text or a template using the guide's supported message syntax. | Request metadata, synchronous result/reference and later delivery result. |
POST /getHSM | Fetch the approved template list available for the connected account. | Returned list and the selected template's send syntax. |
Copy request structures from the current quick start and supply values for your connection and permitted test recipient. Check the operation and intended effect before sending it. The table above is a preparation checklist; the guide supplies the actual request and response examples.
For the documented structures, use the message-send reference, approved-template list reference and callback payload reference. They cover request bodies, template send syntax and the two event shapes illustrated in the quick start. Confirm additional operations and incoming transport details for the connection before implementing them.
Check incoming text, a reply and a template
- Have the test contact write to the business number. Use the incoming-text guide to validate the root
messageevent, nested text kind, source, reference and text, and confirm the intended application conversation. - Send one ordinary reply through
/whatsappmessageinside the active service window. Use the first-message guide for the message rules. - Record the synchronous result. A
submittedresponse represents acceptance into the queue; inspect the latermessage-eventusing the delivery-status guide. - Fetch the approved templates with
/getHSM. Select one suitable for the permitted test, review its text/variables and follow the quick start's template syntax. The template guide covers preparation in the ChatArchitect cabinet. - Observe the small template test separately from the earlier text reply. Compare request, available callback result and what the test phone actually received.
Use the correlation rule confirmed for your connection. Preserve unmatched or missing results for diagnosis; the sample does not establish universal equality between references, a fixed event order or receipt of every status.
Record what each result establishes
| Result | Next check |
|---|---|
| API request fails | Record its HTTP result/error, operation and time. Check credentials, input and account/connection according to the current guide. |
| Request is submitted | Retain the returned reference and inspect the later delivery outcome for the same attempt. |
| No callback reaches the receiver | Check registration, public route and the intended connection using the staged test. |
| Receiver gets an event but the application shows no item | Check sender verification, validation, connection mapping and processing outcome separately. |
| Template is absent or unavailable | Review the connected account, approved list and template status before choosing the next action. |
Before customer use, retain the small test results and unresolved issues, confirm who handles incoming replies and apply the message-data guide to your application's records. For support, share the operation, connection, time, available reference and redacted error without credentials or customer content.
Meta's direct Cloud API guide describes its developer-app and access-token workflow. The ChatArchitect preparation above uses ChatArchitect's issued connection credentials and current API reference.
No comments to display
No comments to display