Webhook

Webhook adalah fitur yang memungkinkan Anda menerima notifikasi secara real-time saat peristiwa tertentu terjadi di BoxHero.

---

Pendaftaran

Anda dapat mendaftarkan webhook di Pengaturan > Integrasi & API di tim BoxHero Anda.

Perilaku Pengiriman & Pengulangan

Saat suatu peristiwa terjadi, BoxHero mengirim permintaan HTTP POST ke endpoint webhook terdaftar Anda. Isi permintaan berisi payload JSON yang menjelaskan peristiwa tersebut.

• Jika server Anda merespons dengan HTTP 200 OK, peristiwa dianggap berhasil terkirim.

• Jika server Anda merespons dengan kode status selain 200 apa pun, BoxHero menganggapnya sebagai kegagalan sementara dan mencoba mengirim ulang hingga 3 kali.

Struktur Payload Webhook

Semua event webhook dikirim dengan struktur JSON berikut di body permintaan:

{
  "id": "1234", // ID unik event
  "topic": "txs/new", // Topik event
  "version": 1, // Versi skema payload
  "payload": { // Data khusus event
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // Stempel waktu terjadinya event (ISO 8601)
}

---

Urutan Event

BoxHero tidak menjamin urutan pengiriman event. Misalnya, event item/new dapat tiba setelah event item/delete untuk item yang sama.

Fitur created_time bidang dalam payload event mewakili waktu sebenarnya dari event. Terapkan logika yang idempotent dan toleran terhadap urutan di handler webhook Anda untuk menangani event dengan andal.

Topik Event

Jika Anda memerlukan dukungan untuk topik event tambahan, silakan hubungi Dukungan.

txs/new

Dipicu saat terjadi transaksi inventaris (Stock In / Stock Out / Adjust Stock / Move Stock).

Catatan: Event ini tidak dipicu untuk penyesuaian yang dibuat melalui pengeditan massal atau impor (misalnya, saat menambahkan atau memperbarui item melalui Excel).

Bidang	Wajib	Deskripsi
id		ID unik transaksi
type		Jenis transaksi (in, out, adjust, move)
mitra		Partner
partner.id		ID unik partner
partner.name		Nama partner
partner.deleted		Apakah partner dihapus
from_location		Lokasi sumber
from_location.id		ID unik lokasi sumber
from_location.name		Nama lokasi sumber
from_location.deleted		Apakah lokasi sumber dihapus
to_location		Lokasi tujuan
to_location.id		ID unik lokasi tujuan
to_location.name		Nama lokasi tujuan
to_location.deleted		Apakah lokasi tujuan dihapus
items		Item baris dalam transaksi
items.id		ID unik item
items.name		Nama item
items.quantity		Perubahan inventaris akibat stock in/out/adjust/move
items.deleted		Apakah item dihapus
items.from_location_new_stock_level		Tingkat stok di lokasi sumber setelah transaksi
items.to_location_new_stock_level		Tingkat stok di lokasi tujuan setelah transaksi
transaction_time		Waktu transaksi (mis. waktu stock in/out)
created_at		Waktu saat transaksi dibuat
created_by		Anggota yang membuat transaksi
created_by.id		ID unik anggota
created_by.name		Nama anggota
created_by.deleted		Apakah anggota dihapus
count_of_items		Jumlah item
total_quantity		Total perubahan inventaris
url		Alamat URL untuk melihat halaman detail transaksi
memo		Catatan terkait transaksi

Contoh Payload Webhook – Masuk Stok Event

{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}

Contoh Payload Webhook – Pindahkan Stok Event

{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Warehouse 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2025-04-25T05:42:27.545Z",
  "created_at": "2025-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Tony Lee",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

txs/edit

Dikirim saat transaksi inventaris yang sudah ada (Stock In / Stock Out / Adjust Stock / Move Stock) diedit.

Bidang	Wajib	Deskripsi
id		ID unik transaksi
type		Jenis transaksi (in, out, adjust, move)
mitra		Partner
partner.id		ID unik partner
partner.name		Nama partner
partner.deleted		Apakah partner dihapus
from_location		Lokasi sumber
from_location.id		ID unik lokasi sumber
from_location.name		Nama lokasi sumber
from_location.deleted		Apakah lokasi sumber dihapus
to_location		Lokasi tujuan
to_location.id		ID unik lokasi tujuan
to_location.name		Nama lokasi tujuan
to_location.deleted		Apakah lokasi tujuan dihapus
items		Item baris dalam transaksi
items.id		ID unik item
items.name		Nama item
items.quantity		Perubahan kuantitas akibat transaksi (in/out/adjust/move)
items.deleted		Apakah item dihapus
items.from_location_new_stock_level		Tingkat stok di lokasi sumber setelah transaksi
items.to_location_new_stock_level		Tingkat stok di lokasi tujuan setelah transaksi
transaction_time		Waktu transaksi (mis. waktu stock in/out)
created_at		Waktu saat transaksi dibuat
created_by		Anggota yang membuat transaksi
created_by.id		ID unik anggota
created_by.name		Nama anggota
created_by.deleted		Apakah anggota dihapus
count_of_items		Jumlah item
total_quantity		Total perubahan inventaris
url		Alamat URL untuk melihat halaman detail transaksi
memo		Catatan terkait transaksi
revision		Nomor versi transaksi saat ini, dimulai dari 1

Contoh Payload Webhook – Diedit Masuk Stok Transaksi

{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}

Contoh Payload Webhook – Diedit Pindahkan Stok Transaksi

{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Warehouse 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Joy Kim",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

txs/delete

Dikirim saat transaksi inventaris dihapus.

Bidang	Deskripsi
id	ID unik transaksi
revision	Nomor versi transaksi saat ini, dimulai dari 1

Contoh Payload Webhook – Transaksi Dihapus

/{
  "id": 27036740,
  "revision": 2
}

item/new

Dikirim saat item baru ditambahkan ke inventaris tim.

Catatan: Event ini tidak dipicu saat menggunakan fitur Add Item Variants atau saat mengimpor item melalui Import Excel.

Bidang	Deskripsi
id	ID Item
name	Nama Item
sku	SKU
barcode	Barcode
photo_url	URL Foto
cost	Biaya
price	Harga
attrs	Atribut

Contoh Payload – Item Dibuat

{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Category",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Expiration date",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

Dikirim saat item yang sudah ada diedit.

Catatan: Event ini tidak dipicu for bulk edits made through Pusat Data > Item or via the Import Excel function.

Bidang	Deskripsi
id	ID Item
name	Nama Item
sku	SKU
barcode	Barcode
photo_url	URL Foto
cost	Biaya
price	Harga
attrs	Atribut

Contoh Payload – Item Diperbarui

{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Category",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Expiration date",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

Dikirim saat item dihapus dari inventaris tim.

Catatan: Event ini tidak dipicu untuk penghapusan massal yang dilakukan melalui Pusat Data > Item.

Bidang	Deskripsi
id	ID Item

Contoh Payload – Item Dihapus

{
  "id": 26122826
}