Whatsapp API

Offer Agreement - [11. PARTY DETAILS]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:17:39 +0000

Offer Agreement

Public Offer to Conclude an Agreement for Access to the "Whatsgate" Software

This Agreement is addressed to persons wishing to obtain access to the “Whatsgate” software located on the Internet at https://whatsgate.org/, hereinafter referred to as the “User”, and is an official and public offer of the party hereinafter referred to as the “Provider”, represented by individual entrepreneur Denis Vyacheslavovich Gorelkin, regarding the use of the “Whatsgate” software package under the following terms:

Terms and Definitions

To avoid ambiguity and other misunderstandings in the interpretation of this Agreement, the Parties agreed on the following terms and definitions:

Provider means developer of the “Whatsgate” software.

“Whatsgate” software (also referred to as “Whatsgate Software”) means a set of cloud services including server equipment and software built by the Provider using web technologies, available through a web browser, as well as a local client installed on the User's computer.

SaaS (Software as a Service) means a model of providing User access to “Whatsgate” software under which the software is not transferred to the User's ownership, and payment is charged for usage according to the Tariff Plan in Appendix No. 1 to this Agreement.

Billing Period means the minimum period for which services are provided. Under this Agreement, the Billing Period is 1 (one) calendar month starting on the first day and ending on the last day of the calendar month.

Tariff Plan means the list of services provided by the Provider to the User, their cost, and payment procedure.

User Account means the configurable virtual workspace of the User in the “Whatsgate” software.

1. SUBJECT OF THE AGREEMENT

1.1 The subject of this Agreement is the Provider's provision to the User, under the terms and within the scope defined by this Agreement, of services for access to the “Whatsgate” Software located at https://whatsgate.org/. The Provider is the owner, developer, and holder of exclusive rights to the “Whatsgate” software.

1.2 Access limitations included in the Tariff Plan are set out in Appendix No. 1 to this Agreement.

1.3 The User may use access to the “Whatsgate” software through a web browser at any time.

2. RIGHTS AND OBLIGATIONS OF THE PARTIES

2.1 The Provider shall:

2.1.1 Provide the User with access to the “Whatsgate” software by registration in the system with assignment of a unique login and password, followed by creation of a separate working account.

2.1.2 Provide the User, free of charge, with informational support on working with the System via email and via records in social networks and the Provider's blog. Current contacts are available in the Help section of the provided “Whatsgate” software (https://whatsgate.org/docs/). Extended support in the form of a personal manager, system setup and training, and analyst assistance depends on the selected Tariff Plan (Appendix No. 1).

2.1.3 Independently, timely, and free of charge update the current version of the “Whatsgate” software during the Agreement term.

2.1.4 Ensure 24/7 availability of the “Whatsgate” software with possible technical interruptions totaling no more than 1 (one) hour per week. Respond (take action) to User reports regarding system performance issues within 48 (forty-eight) hours from receipt of such report or claim.

2.1.5 Ensure storage, backup, and archival storage of User data.

2.1.6 If technically possible, timely eliminate possible software failures in “Whatsgate” software based on User requests.

2.1.7 Strictly comply with this Agreement and ensure confidentiality of commercial and technical information received during cooperation with the User, as defined in Section 7 of this Agreement.

2.2 The Provider has the right to:

2.2.1 Suspend or block access to the “Whatsgate” software in case of untimely payment by the User, notifying the User at least 3 (three) business days in advance by email or another method.

2.2.2 Change tariff policy and unilaterally amend it, as well as change service terms for the next Billing Period, notifying the User at least 1 (one) calendar month in advance by email or another method.

2.2.3 Unconditionally suspend or block User access to the “Whatsgate” software if the User uses the system for purposes prohibited by the laws of the Russian Federation or violates third-party rights.

2.3 The User shall:

2.3.1 Pay for access to the “Whatsgate” software according to the selected Tariff Plan, taking into account the provisions of Appendix No. 1 and Clause 3.5 of this Agreement.

2.3.2 Not use the “Whatsgate” software for purposes prohibited by the laws of the Russian Federation and not violate third-party rights under applicable legislation of the Russian Federation.

2.3.3 Strictly comply with this Agreement and ensure confidentiality of commercial and technical information obtained in cooperation with the Provider, as defined in Section 7 of this Agreement.

2.4 The User has the right to:

2.4.1 Use the provided access to the “Whatsgate” software to perform the following actions, including but not limited to other actions provided by the “Whatsgate” software.

2.4.2 Use the provided access to the “Whatsgate” software in accordance with its intended purpose.

2.4.3 Submit requests to the Provider for elimination of failures and errors in operation of the “Whatsgate” software.

3. PAYMENT PROCEDURE

3.1 The cost of Services is determined according to the Provider's effective Tariff Plan (Appendix No. 1 to this Agreement).

3.2 Services are provided to the User on a prepaid basis. The User makes an advance payment of 100% (one hundred percent) of the total cost of ordered Services based on an invoice issued by the Provider to the User for payment (“Invoice”), within 5 (five) business days from Invoice issue date. Funds are credited by the Provider to the User Account within 1 (one) business day from receipt of funds to the Provider's settlement account.

3.3 Delivery and acceptance of services is performed as follows:

3.3.1 Monthly, on the last day of the reporting month and/or upon completion of Services under this Agreement, the Provider prepares a Service Acceptance Act according to the volume of services provided during the reporting period.

3.3.2 Services are considered properly provided by the Provider and accepted by the User in the volume specified in the Act if, within three business days after the end of the reporting period, the Provider has not received reasoned written objections from the User. After this period, User claims regarding deficiencies of Services, including quantity (volume), cost, and quality, are not accepted.

3.4 Signing of documents for Users that are legal entities is performed only via electronic document management (EDM). Original paper copies are delivered only at User request, and delivery cost is paid by the User.

3.5 The cost of services provided under this Agreement is not subject to VAT due to the Provider's use of the simplified taxation system in accordance with Chapter 26.2 of the Tax Code of the Russian Federation.

3.6 Payment date is the date funds are received to the Provider's settlement account. Payment is made in Russian rubles.

3.7 In case of early termination of this Agreement at the initiative of either Party, the Provider shall settle accounts with the User within 15 (fifteen) calendar days from receipt of termination notice.

4. TERM OF THE AGREEMENT

4.1 This Agreement is an offer in accordance with Article 435 of the Civil Code of the Russian Federation, therefore the Provider may revoke this Agreement as an offer in accordance with Article 436 of the Civil Code of the Russian Federation. If revoked by the Provider during its term, this Agreement is deemed terminated from the moment of revocation. Revocation is made by publishing relevant information on the Service website.

4.2 If, upon expiration of this Agreement, either Party does not notify the other of refusal to continue, the Agreement is automatically extended on the same terms for 1 (one) calendar month.

4.3 The Agreement is extended under the current tariff plan, or a newly selected tariff plan, provided there are sufficient funds in the User account and no notice of termination or amendments to the Agreement.

5. TERMINATION OF THE AGREEMENT

5.1 The Parties may terminate this Agreement early by mutual written agreement.

5.2 If the User breaches this Agreement, the Provider may unilaterally terminate the Agreement, notifying the breaching Party by sending notice to the User's email. The Provider's unilateral refusal to perform this Agreement (fully or partially) is allowed in case of material breach by the User. Breach is considered material if:

- the User delays monthly payments specified in Section 3 of this Agreement by more than 30 (thirty) calendar days;

- the User uses granted access rights to the “Whatsgate” software for purposes contrary to the Agreement and/or law.

5.3 The User may terminate the Agreement unilaterally at any time by notifying the Provider 15 (fifteen) calendar days before the intended termination date. Termination notice is sent in electronic form to service@whatsgate.org.

6. LIABILITY OF THE PARTIES. LIMITATION OF LIABILITY

6.1 The Parties are liable for non-performance or improper performance of their obligations under this Agreement in accordance with the legislation of the Russian Federation.

6.2 The Parties understand that the “Whatsgate” software is based on software components, and the Provider gives no express or implied warranties that the “Whatsgate” software will meet all User requirements or expectations, or fit User goals and objectives. Access to the “Whatsgate” software is provided under the generally accepted worldwide “AS IS” principle.

6.3 The User uses the “Whatsgate” software at their own risk. The Provider is not responsible for exact correspondence of the “Whatsgate” software to the User's business processes.

6.4 The Provider is not responsible for any User actions related to use of the “Whatsgate” software.

6.5 The Provider is not liable to the User for damages of any kind incurred due to loss and/or disclosure of User credentials for access to the “Whatsgate” software.

6.6 The Provider ensures basic information security of User data within normal conditions. Basic information security means the state of information protection in which confidentiality, availability, and integrity are ensured.

6.7 The Provider is not liable to the User for delays and service interruptions occurring directly or indirectly due to reasons beyond the Provider's reasonable control.

6.8 The Provider is not liable for quality of services (in particular data transfer services and mobile network operator services) required for use of the “Whatsgate” software if such services are organized by third parties not engaged by the Provider.

6.9 The User agrees that work with the “Whatsgate” software requires software (web browsers, operating systems, etc.) and equipment (personal computers, mobile phones, tablets, network equipment, etc.) produced and provided by third parties, and the Provider cannot be responsible for their quality.

6.10 The User agrees that no software is error-free.

6.11 In case of data loss caused by User actions, data recovery is performed upon request to the Provider and only if technically possible.

7. CONFIDENTIALITY

7.1 The purpose of this section is to protect information disclosed by the Parties to each other during cooperation under this Agreement.

7.2 The Parties agree to treat all information provided to each other within this Agreement or in connection with its purpose, by partners/clients of the Parties, as well as information about this Agreement and proposals made, as Confidential Information (and, to the extent permitted by applicable Russian law, as a trade secret), unless otherwise directly follows from this Agreement and its appendices.

7.3 Each party receiving Confidential Information (“Receiving Party”) from the other party (“Disclosing Party”) shall not disclose Confidential Information to anyone without direct permission of the Disclosing Party and shall take all reasonable measures to protect Confidential Information, including all measures used to protect its own confidential information/trade secrets.

7.4 The Receiving Party shall use disclosed Confidential Information solely for implementation of this Agreement.

7.5 The Receiving Party shall limit access to Confidential Information strictly to its own employees and employees of its contractors directly involved in execution of this Agreement, with whom the Receiving Party has a similar confidentiality agreement.

7.6 Obligations in this section do not apply to:

- information that is or becomes publicly known through no fault of the receiving Party, which must be confirmed by appropriate evidence;

- information received by the Parties from third parties without confidentiality obligations;

- information independently developed by a Party;

- information whose disclosure is required under law or by competent authorities. Such information may be disclosed only to competent authorities in the procedure provided by applicable law.

7.7 Disclosure of confidential information to third parties is not considered a breach if there is written consent of the Party that provided such confidential information.

7.8 For each breach of confidentiality obligations under this Agreement, the Receiving Party shall compensate all and any losses caused by such breach.

7.9 Confidentiality obligations under this Agreement remain valid for 3 (three) years from the date of transfer of Confidential Information.

7.10 The Provider may aggregate, systematize, and analyze information received from the User, including confidential information, for creation of analytical reports and databases, while guaranteeing non-disclosure and protection of confidential information contained in such reports and databases according to this Agreement and applicable legislation of the Russian Federation.

7.11 The Provider may deconfidentialize information received from the User, including by anonymizing User data and other protected information, to create analytical reports and databases that do not contain confidential information.

8. FORCE MAJEURE

8.1 The Parties are not liable for non-performance of obligations under this Agreement if such non-performance is caused by force majeure circumstances.

8.2 Force majeure means extraordinary events arising beyond the will of the Parties, the impact of which they could not prevent (such as natural disasters, fires, accidents, catastrophes, military actions), resulting in inability of a Party to perform obligations under this Agreement.

8.3 A Party affected by force majeure shall take all necessary actions and measures reasonably expected in the situation and immediately notify the other Party of occurrence of force majeure.

8.4 The term for performance of obligations under this Agreement for a Party affected by force majeure is extended for the period of such circumstances and their consequences.

8.5 A Party for which performance has become partially or fully impossible due to force majeure shall notify the other Party within 5 (five) business days about the beginning, progress, change of scale/nature, and termination of force majeure. If untimely notice causes losses to the other Party, such losses shall be compensated by the affected Party within the amount of actually incurred damage.

8.6 The burden of proving force majeure rests on the Party invoking it.

9. DISPUTE RESOLUTION PROCEDURE

9.1 In case of disputes under or in connection with this Agreement, the Parties shall take all measures to resolve them through negotiations.

9.2 If the Parties fail to reach agreement, such disputes shall be resolved in court at the Provider's place of registration (Russian Federation, Tambov) in accordance with applicable legislation of the Russian Federation.

10. ADDITIONAL TERMS

10.1 All appendices, amendments, and additions to this Agreement are an integral part of it and have legal force if made in writing and signed by authorized representatives of the Parties.

10.2 The Provider may unilaterally amend service terms by publishing relevant information on the Service website in public access and by amending this Agreement (offer). At the same time, services paid by the User before such amendments are made shall be performed by the Provider without regard to such amendments.

10.3 If address or details of either Party change, such Party shall notify the other Party within 10 (ten) business days.

10.4 All issues not regulated by this Agreement are governed by the legislation of the Russian Federation.

10.5 Any amendments and additions to this Agreement are valid only if made in writing as appendices or supplemental agreements to this Agreement and signed by duly authorized representatives of the Parties.

11. PARTY DETAILS

E-mail: service@whatsgate.org

api:get-media - removed

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:14:59 +0000

This command is deprecated and will be removed over time.

Use the get-messagemedia method

Working with media files (deprecated)

This command lets you retrieve a media file attached to a received message. If a message contains media, the message field “hasMedia” is set to true, and the “mediaKey” field contains the media identifier used by this command.

Request command

To request media, send a POST request to:

https://whatsgate.org/api/v1/get-media

Request body object

The request body must contain:

{
  "WhatsappID": "YOUR_WHATSAPP_ID",
  "mediaKey": "TuM9wXQZBmERUCzwnIZe80GwZ5lPDIDsNE+vewnAxho="
}

WhatsappID - WhatsApp identifier in the system
mediaKey - media file identifier

Response object

Successful response object

{
  "result": "OK",
  "media": {
    "mimetype": "image/jpeg",
    "filename" : "image.jpg",
    "data": "<base64_encoded_data>"
  }
}

In the response, the “media” field contains a media file object

Changing session name - [Response object]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:14:09 +0000

Changing session name

This command changes the name of the specified WhatsApp session.

Request command

To change a session name, send a POST request to:

https://app.whatsgate.org/api/v1/set-name

Request body object

The request body must contain:

{
  "WhatsappID": "YOUR_WHATSAPP_ID",
  "name": "new name"
}

WhatsappID - WhatsApp identifier in the system
name - new session name

Response object

Successful response object

{
  "result": "OK",
  "data":  {
     "id": 151,
     "name": "new name",
     "unique_id": "6345454545454",
     "status": "READY",
     "callback": "https://callback.my/script.handler",
     "date_add": "2022-10-11 19:30:14",
     "status_name": "Working",
     "pushname": "John",
     "wid": "19991234567@c.us",
  }
}

data - session object

Getting the session list - [Response object]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:13:27 +0000

Getting the session list

This command is used to get the list of sessions for an account.

Request command

To retrieve the session list, send a POST request to:

https://app.whatsgate.org/api/v1/sessions-get

Request body object

The request body accepts:

{
  "WhatsappID" : "",
  "name" : "",
  "status" : "",
  "page_cnt" : "",
  "page" : ""
}

All fields in this object are optional, so an empty object is enough to get the full list of active sessions. Fields WhatsappID, name, and status are filters.

WhatsappID - filter by WhatsApp identifier, exact match; returns one session with the specified identifier.
name - filter by name, partial match.
status - session status filter. Can be one of:
- AUTH - sessions in authorization status.
- READY - sessions in working state.
- ERROR - sessions in error state.
- CLOSED - closed sessions (due to error or end of paid period)
page_cnt - maximum sessions returned per page. Default is 50, maximum is 100.
page - page number. Default is 1

Response object

Successful response object

{
  "result": "OK",
  "pages" : 1,
  "elements" : 2,
  "page" : 1,
  "data" : [
     {
        "id": 151,
        "name": "My WhatsApp 1",
        "unique_id": "6345454545454",
        "status": "AUTH",
        "callback": "",
        "date_add": "2022-10-11 19:30:14",
        "status_name": "Authorization",
        "pushname": null,
        "wid": null,
        "qr_link": "https://app.whatsgate.org/qr/6345454545454"
     },
     {
        "id": 152,
        "name": "My WhatsApp 2",
        "unique_id": "6345454545455",
        "status": "READY",
        "callback": "",
        "date_add": "2022-10-12 10:35:01",
        "status_name": "Working",
        "pushname": "John",
        "wid": "19991234567@c.us",
        "qr_link": ""
     },
  ]
}

result - contains “OK” when the request succeeds
pages - number of pages for the selected filters
elements - number of elements in the filtered result (number of WhatsApp sessions returned)
page - current page number
data - contains an array of WhatsApp session objects

Deleting a session via API - [Response object]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:12:36 +0000

Deleting a session via API

Deleting a session means WhatsApp authorization is terminated, all session data is removed from Whatsgate servers, and resources are released (for example, if your plan allows only 1 session, you cannot create a new one until the current session is deleted).

Request command

To send this request, issue a POST request to:

https://app.whatsgate.org/api/v1/session-delete

Request body object

The request body must contain:

{
  "WhatsappID": "YOUR_WHATSAPP_ID"
}

WhatsappID - WhatsApp identifier in the system

Response object

Successful response object

{
  "result": "OK",
  "data": {
        "id": 456,
        "name": "My Whatsapp",
        "unique_id": "YOUR_WHATSAPP_ID",
        "status": "DESTROYING",
        "callback": null,
        "date_add": "2022-10-12 07:10:49",
        "status_name": "Deleting",
        "pushname": "John",
        "wid": "19991234567@c.us",
    }
}

Creating a session via API - [Embedding the QR page]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:12:03 +0000

Creating a session via API

This command opens a WhatsApp session to link it to the service. After opening, you must authorize WhatsApp through the mobile app and QR code. If the session is no longer needed, close it using session-delete.

Request command

To create a session, send a POST request to:

https://app.whatsgate.org/api/v1/session-create

Request body object for QR authorization

The request body must contain:

{
  "name" : "My WhatsApp",
  "callback" : "https://callback.my/script.handler"
}

name - WhatsApp name in the system (for easier identification)
callback - URL of the incoming events handler (optional, can be set later via set-hook)

Request body object for CODE authorization

The request body must contain:

{
  "name" : "My WhatsApp",
  "callback" : "https://callback.my/script.handler",
  "auth_type" : "CODE",
  "number" : "19999999999"
}

name - WhatsApp name in the system (for easier identification)
callback - URL of the incoming events handler (optional, can be set later via set-hook)
auth_type - authorization type set to code. In this mode, phone number becomes required.
number - phone number to connect in 7XXXXXXXXXX format

Response object

Successful response object

{
  "result": "OK",
  "data" : {
     "id": 151,
     "name": "My WhatsApp",
     "unique_id": "6345454545454",
     "status": "PENDING",
     "callback": "https://callback.my/script.handler",
     "date_add": "2022-10-11 19:30:14",
     "qr": null,
     "status_name": "Initialization",
     "pushname": null,
     "wid": null,
     "qr_link": "https://app.whatsgate.org/qr/6345454545454"
  }
}

result - contains “OK” when the request succeeds.
data - contains created session object including its unique identifier unique_id and QR authorization link qr_link.
qr or code depends on selected authorization type. If code authorization is selected, the code is returned in code. Field qr_link points to the authorization code page.

QR authorization window

The QR authorization window is available at:

https://app.whatsgate.org/qr/<unique_id>

For convenience, this link is returned in qr_link when creating a session. The QR code in this window is updated periodically and changes to a success or error image after authorization.

Embedding the QR page

This page can be embedded into your app via iframe, and parent page can receive messages from it. Embedding example:

<h1>QR test code</h1>

<iframe src="https://app.whatsgate.org/qr/6345454545454" width="310" height="310" style="border: none;">

</iframe>

<div class="log" id="log">

</div>

<script>
    window.addEventListener("message", function(event) {

        console.log(event);

        if (event.origin !== 'https://whatsgate.org') {
            // something came from an unknown domain; ignore it
            return;
        }

        if(typeof event.data !== 'object') {
            // message must be an object
            return;
        }

        if(!('module' in event.data) && event.data.module !== 'qr'){
            // object must contain module field with value qr
            return;
        }

        //if we're here, the message is valid; output it
        console.log( "received: " + event.data.message);
        //append message to parent-page log
        document.getElementById('log').append("received: " + event.data.message, document.createElement("br"));
    });
</script>

The message object is in event.data and has this format:

{
  "module" : "qr",
  "message" : "<message>"
}

module - always has value qr, to identify relevant messages
message - can have the following values:
- loading - session initialization and QR code loading; sent at page load start
- qr - QR code has been generated and displayed; sent each time code refreshes
- success - device authorized successfully; QR code is hidden
- error - authorization error occurred; try again
- broken - attempt to open a window with non-existing or closed session identifier

Incoming events processing (events-get) - [Request command]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:10:25 +0000

Incoming events processing (events-get)

This command is used to request and retrieve a list of incoming events, such as:

incoming messages (action = message)
message read/update (action = ack)
incoming media file (action = media)
message sent (action = sent) - this event appears only for asynchronous sending
error (action = error)
WhatsApp disconnect and session removal (action = disconnect)

Request command

To retrieve the event list, send a POST request to:

https://app.whatsgate.org/api/v1/events-get

Request body object

The request body accepts the following object:

{
  "WhatsappID" : "XXXXXXXXXXXXX",
  "date" : "YYYY-MM-DD HH:MM:SS",
  "action" : "message",
  "page_cnt" : "10",
  "page" : "1"
}

All fields in this object are optional, meaning an empty object is enough to get the full list of events. Fields WhatsappID and action are filters, and date limits events by date. The date is typically used like this: after reading events, take the date of the last event and pass it in the next request as date to fetch only newer events.

WhatsappID - filter by WhatsApp identifier; uses exact match and returns events for the specified session. If omitted, the system returns events for all sessions, including deleted ones.
date - limits events by the specified date. A common pattern is to reuse the latest received event date in the next request to get fresh events only.
action - event type filter. Can be one of:
- message - incoming message.
- ack - message status update.
- media - incoming media file.
- sent - message sent (only when sending asynchronously)
- error - error
- disconnect - WhatsApp disconnect and session deletion
- create - outgoing message
page_cnt - maximum number of events per response page. Default is 10, maximum is 100.
page - response page number. Default is 1

Response object

Successful response object

{
  "result": "OK",
  "pages" : 1,
  "elements" : 2,
  "page" : 1,
  "data" : [
     // 
  ]
}

result - contains “OK” when the request succeeds
pages - number of pages for the given filters
elements - number of matching elements (event count)
page - current page number
data - contains an array of objects representing events.

Incoming processing (Webhook) - [Message object]

denis716@undisclosed.example.com (denis716) — Fri, 25 Sep 2026 21:09:52 +0000

Incoming processing (Webhook)

Webhook is used to process incoming events, asynchronous request responses, and error information. For example, when an incoming message is received in the messenger, a POST request is sent to the configured webhook:

{
  "id":18,
  "whatsapp_id":"191b80a9238",
  "event_action":"message",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "message": 
    {
       "_id" : "3EB0436AE1E682FF3A37",
       "id":"false_19999999999@c.us_3EB0436AE1E682FF3A37",
       "ack":1,
       "hasMedia":false,
       "mediaKey":"",
       "body":"212",
       "type":"chat",
       "timestamp":1662575377,
       "from":"19991112233@c.us",
       "to":"19999999999@c.us",
       "isForwarded":false
    }
  }
}

To confirm successful event receipt, your webhook must return a JSON object containing the incoming event identifier and status OK.

{
  "result" : "OK",
  "id" : 18
}

If the system does not receive a valid response, it retries the request 3 times every 20 seconds.

Webhook setup

Webhook setup in account dashboard

To set a Webhook handler URL, open your account dashboard, choose the linked WhatsApp block, click the 3 dots, then click edit.

In the opened window, specify the URL to your Webhook handler script.

Click “Save”.

Webhook setup via API

To enable or disable WebHook via API, use the set-hook method. Send a POST request to:

https://app.whatsgate.org/api/v1/set-hook

Request body:

{
  "WhatsappID": "YOUR_WHATSAPP_ID",
  "callback": "https://callback.my/script.handler"
}

WhatsappID - WhatsApp identifier in the system
callback - URL of incoming events handler

Successful response object

{
  "result": "OK"
}

Event types

Ready

This event is sent after authorization, when the client is fully ready to send and receive messages. Session status changes from AUTH to READY. Field event_action contains “ready”. Field event_data contains authorized account data: number and name.

pushname - client's name in messenger
number - authorized phone number
id - WhatsApp identifier in @c.us format

{
  "id":19,
  "whatsapp_id" : "191b80a9238",
  "event_action" : "ready",
  "event_date" : "2023-01-24 18:29:37",
  "status_code" : null,
  "event_data" :
  {
    "pushname": "John",
    "number" : "19991234567",
    "id" : "19991234567@c.us"
  }
}

Message

This event is sent for any incoming message in a chat or group. Field event_action contains “message”. Field event_data contains a message object.

{
  "id":18,
  "whatsapp_id":"191b80a9238",
  "event_action":"message",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "message": 
    {
       "_id":"3EB0436AE1E682FF3A37",
       "id":"false_19999999999@c.us_3EB0436AE1E682FF3A37",
       "ack":1,
       "hasMedia":false,
       "mediaKey":"",
       "body":"212",
       "type":"chat",
       "timestamp":1662575377,
       "from":"19991112233@c.us",
       "to":"19999999999@c.us",
       "isForwarded":false
    }
  }
}

Sent

This event is sent after successful message delivery when an asynchronous send command was used.

Field event_action contains “sent”. Field event_data contains the delivered message object.

{
  "id":19,
  "whatsapp_id":"191b80a9238",
  "event_action":"sent",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "message": 
    {
       "_id":"3EB0436AE1E682FF3A37",
       "id":"false_19999999999@c.us_3EB0436AE1E682FF3A37",
       "ack":1,
       "hasMedia":false,
       "mediaKey":"",
       "body":"212",
       "type":"chat",
       "timestamp":1662575377,
       "from":"19999999999@c.us",
       "to":"19991112233@c.us",
       "isForwarded":false
    }
  }
}

Ack

This event is sent when a message status changes in a chat or group. Field event_action contains “ack”. Field event_data contains the message object whose status changed. Message status is in message field ack and can be: 1 - sent, 2 - delivered, 3 - read.

{
  "id":19,
  "whatsapp_id":"191b80a9238",
  "event_action":"ack",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "message": 
    {
       "_id":"3EB0436AE1E682FF3A37",
       "id":"false_19999999999@c.us_3EB0436AE1E682FF3A37",
       "ack":1,
       "hasMedia":false,
       "mediaKey":"",
       "body":"212",
       "type":"chat",
       "timestamp":1662575377,
       "from":"19999999999@c.us",
       "to":"19991112233@c.us",
       "isForwarded":false
    }
  }
}

Disconnect

This event is sent when the client disconnects and closes. This happens when you remove the client from your account dashboard or revoke the link in the WhatsApp mobile app. Field event_action contains “disconnect”. Field event_data contains an object with field reason describing the disconnect cause.

{
  "id":19,
  "whatsapp_id":"191b80a9238",
  "event_action":"disconnect",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "reason": "Client disconnected"
  }
}

Error

This event is sent when any error occurs. For example, when you try to send asynchronously to a number outside your contact list on the Light plan. Field event_action contains “error”. Field event_data contains an object describing the error.

{
  "id":19,
  "whatsapp_id":"191b80a9238",
  "event_action":"error",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "error":"Specified number not in your contact list"
  }
}

Create

This event is sent for any outgoing message in a chat or group. It lets you track sent messages via webhook, including messages sent from the mobile client or other linked applications.

Field event_action contains “create”.

Field event_data contains a message object.

{
  "id":18,
  "whatsapp_id":"191b80a9238",
  "event_action":"create",
  "event_date":"2022-09-07 18:29:37",
  "status_code":null,
  "event_data":
  {
    "message": 
    {
       "_id":"3EB0436AE1E682FF3A37",
       "id":"true_19999999999@c.us_3EB0436AE1E682FF3A37",
       "ack":1,
       "hasMedia":false,
       "mediaKey":"",
       "body":"212",
       "type":"chat",
       "timestamp":1662575377,
       "from":"19991112233@c.us",
       "to":"19999999999@c.us",
       "isForwarded":false
    }
  }
}

Message object

{
   "_id":"3EB0436AE1E682FF3A37",
   "id":"false_19999999999@c.us_3EB0436AE1E682FF3A37",
   "ack":1,
   "hasMedia":false,
   "mediaKey":"",
   "body":"212",
   "type":"chat",
   "timestamp":1662575377,
   "from":"19999999999@c.us",
   "to":"19991112233@c.us",
   "isForwarded":false,
   "quoted": {
       "_id": "3EB07621A4D08F9F59E0",
       "from": "19537226631@c.us",
       "type": "chat",
       "body": "Hello!"
   }
}

Message object fields:

_id - message identifier in WhatsApp.
id - WhatsApp message identifier that can be passed in the “quote” field to mark a message as a reply.
ack - (int) status flag showing message state: 1 - sent, 2 - delivered, 3 - read
hasMedia - flag indicating whether message contains a media file
mediaKey - media file key used in get-media to fetch media.
body - message text
type - message type
timestamp - message date in Unix timestamp format
from - sender identifier
to - recipient identifier
isForwarded - indicates whether the message was forwarded from another chat
quoted - if this message quotes (replies to) another message, quoted contains the quoted message object.
- _id - quoted message identifier
- from - quoted message author identifier
- type - quoted message type
- body - quoted message text

PHP code for webhook request handling

<?php
 
//buffer output
ob_start();
 
var_dump('----------------------' . date('d.m.Y H:i:s') . '----------------');
 
//extract request data
$input = file_get_contents('php://input');
$input_data = json_decode($input, true);
 
var_dump($input_data);
 
if($input_data['event_action'] == 'message') {
    //@TODO process incoming message
 
}
 
if($input_data['event_action'] == 'ack') {
 
    //@TODO process delivery or read status
 
    if($input_data['event_data']['message']['ack'] == 2) {
        //@TODO delivered
    }
    if($input_data['event_data']['message']['ack'] == 3) {
        //@TODO read
    }
}
 
//save log
$fo = fopen('webhook.log', 'a');
fwrite($fo, ob_get_clean());
fclose($fo);
 
//build and output response
$answer_data = [
    'id' => $input_data['id'],
    'result' => 'OK'
];
 
echo json_encode($answer_data);
?>