Webhook

Pada intinya webhook berfungsi untuk meneruskan data yang masuk ke Alat WA ke sistem lain.

contoh: kamu punya data di google sheet dan ingin mencarinya via WhatsApp, kamu perlu menghubungkan alatwa dengan google sheet, nantinya url google sheet diinput kedalam sistem Alat WA, maka ketika setiap ada chat masuk akan diteruskan ke google sheet. Ketika datanya ketemu kamu bisa mengirimkan kembali ke whatsapp customer via API.

Kamu bisa menyimpan URL wehbook pada kolom berikut ini:

• Incoming Message: untuk menerima pesan masuk
• Outgoing Message: untuk menerima pesan yang terkirim dari aplikasi WhatsApp
• Status Notification: untuk menerima status pesan terkirim

Berikut format webhook yang dikirim dari Alat WA:

Incoming Messages

Format

Method: POST
Headers: "Content-Type: application/json"
Body: {
  "device": "Device ID",
  "data": {
    "message_id": "string",
    "related_message_id": "string",
    "type": "string",
    "from_me": boolean,
    "sender_name": "string",
    "sender": "string",
    "receiver": "string",
    "message": "string",
    "media_url": "string",
    "author": "string",
    "created": integer
  }
}

Text

{
  "device": "888111222133155555",
  "data": {
    "message_id": "3FC022B1851111839",
    "related_message_id": "",
    "type": "text",
    "from_me": false,
    "sender_name": "John",
    "sender": "628123123123",
    "receiver": "6289669342954",
    "message": "tes message",
    "media_url": null,
    "author": null,
    "created": 1734656438
  }
}

Media

{
  "device": "888111222133155555",
  "data": {
    "message_id": "3FC022B18511113333",
    "related_message_id": "",
    "type": "text",
    "from_me": false,
    "sender_name": "John",
    "sender": "628123123123",
    "receiver": "6289669342954",
    "message": "tes message",
    "media_url": "https://media.alatwa.com/assets/uploads/customer/default.jpg",
    "author": null,
    "created": 1734656438
  }
}

Text in Group

{
  "device": "888111222133155555",
  "data": {
    "message_id": "3FC022B18511112222",
    "related_message_id": "",
    "type": "text",
    "from_me": false,
    "sender_name": "John",
    "sender": "120363045611111111",
    "receiver": "6289669342954",
    "message": "tes message",
    "media_url": null,
    "author": "628123123123",
    "created": 1734656438
  }
}

Outgoing Messages

Format

Method: POST
Headers: "Content-Type: application/json"
Body: {
  "device": "Device ID",
  "data": {
    "message_id": "string",
    "related_message_id": "string",
    "type": "string",
    "from_me": boolean,
    "sender_name": "string",
    "sender": "string",
    "receiver": "string",
    "message": "string",
    "media_url": "string",
    "author": "string",
    "created": integer
  }
}

Text

{
  "device": "888111222133155555",
  "data": {
    "message_id": "3FC022B1851111839",
    "related_message_id": "",
    "type": "text",
    "from_me": true,
    "sender_name": "John",
    "sender": "628123123123",
    "receiver": "6289669342954",
    "message": "tes message",
    "media_url": null,
    "author": null,
    "created": 1734656438
  }
}

Media

{
  "device": "888111222133155555",
  "data": {
    "message_id": "3FC022B18511113333",
    "related_message_id": "",
    "type": "text",
    "from_me": true,
    "sender_name": "John",
    "sender": "628123123123",
    "receiver": "6289669342954",
    "message": "tes message",
    "media_url": "https://media.alatwa.com/assets/uploads/customer/default.jpg",
    "author": null,
    "created": 1734656438
  }
}

Text in Group

{
  "device": "888111222133155555",
  "data": {
    "message_id": "3FC022B18511112222",
    "related_message_id": "",
    "type": "text",
    "from_me": true,
    "sender_name": "John",
    "sender": "120363045611111111",
    "receiver": "6289669342954",
    "message": "tes message",
    "media_url": null,
    "author": "628123123123",
    "created": 1734656438
  }
}

Status Message

Format

{
  "device": "Device ID",
  "data": {
    "message_id": "string",
    "status_code": integer,
    "status": "string",
    "created": integer
  }
}

Example

{
  "device": "888111222133155555",
  "data": {
    "message_id": "PEFPYI2CPQWWV11111111",
    "status_code": 4,
    "status": "Read",
    "created": 1734657859
  }
}

QR Code for scan device

Format

{
    "device_id": "Device ID",
    "qr": "string"
}

Example

{
    "device_id": "888111222133155555",
    "qr": "2@b5g96Bi11111MrW21aw5yufcccToZQDIAzaNIe\/gSwTB84Ylqqk8U0h5sJKcXWIS9k=,tp5Y3LtUR6aoWy+B4XLBAzbnYfEMuRnOdUt0bvTy2Vo=,6uTGIxJM7MchiW3f39KkfvT46KlBO1YeEJgaU+HDMAo=,kIBq8PDfRG7vkbDc4LACo2GEPVwbjFoDY3Owy7F77vI="
}

Device Connected

Format

{
    "device_id": "Device ID",
    "status": "string"
}

Example

{
    "device_id": "888111222133155555",
    "status": "connected"
}

Device Disconnect

Format

{
    "device_id": "Device ID",
    "status": "string"
}

Example

{
    "device_id": "888111222133155555",
    "status": "disconnect"
}