API Reference

Register webhooks for WhatsApp messages and events

post
https://api.chatarchitect.com/webhook

Registration is used to save the 3 "webhooks" where the API will send messages from WhatsApp. The "destination" in this case is any.

There are 3 webhook types:

  • message webhook: new incoming messages;
  • message event webhook: failed, read, sent, delivered events;
  • user event webhook: user opted in or opted out.

You can set all 3 webhooks, or only 1 or 2. URLs can be the same or different.

If "webhook_separate" is "true", individual URLs for each webhook type are used. If "false" or not set, all types of events will be sent to the "webhook" URL.

Webhooks should start with "https://".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for registering webhooks

string

The communication channel for the webhook (e.g., WhatsApp)

string

The destination phone number or identifier

string

The URL for all webhook events if "webhook_separate" is false or not set

string

The URL for message event webhook if "webhook_separate" is true

boolean
enum

Indicates if separate URLs for different webhook types are used

Allowed:
string

The URL for user event webhook if "webhook_separate" is true

Response

Updated almost 2 years ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago