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 & Coba Ulang

Saat sebuah event terjadi, BoxHero mengirim permintaan HTTP POST ke endpoint webhook yang Anda daftarkan. Isi permintaan berisi payload JSON yang menjelaskan event tersebut.

• Jika server Anda merespons dengan HTTP 200 OK, event dianggap berhasil dikirim.

• Jika server Anda merespons dengan kode status apa pun selain 200, 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. Sebagai contoh, sebuah item/new event dapat tiba setelah item/delete event untuk item yang sama.

Kolom created_time dalam payload event merepresentasikan waktu terjadinya event yang sebenarnya. Terapkan logika idempoten dan toleran terhadap urutan di handler webhook Anda untuk menangani event secara andal.

Topik Event

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

txs/new

Dipicu saat transaksi inventaris terjadi (Stok Masuk / Stok Keluar / Penyesuaian Stok / Pindah Stok).

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

WajibWajib

Kolom	Wajib	Deskripsi
id		ID unik transaksi
type		Jenis transaksi (in, out, adjust, move)
Mitra		Mitra
partner.id		ID unik mitra
partner.name		Nama mitra
partner.deleted		Apakah mitra dihapus
from_location		Lokasi asal
from_location.id		ID unik lokasi asal
from_location.name		Nama lokasi asal
from_location.deleted		Apakah lokasi asal 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 karena stock in/out/adjust/move
items.deleted		Apakah item dihapus
items.from_location_new_stock_level		Level stok di lokasi asal setelah transaksi
items.to_location_new_stock_level		Level stok di lokasi tujuan setelah transaksi
transaction_time		Waktu transaksi (misalnya waktu masuk/keluar stok)
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 jumlah perubahan inventaris
url		URL untuk melihat halaman detail transaksi
memo		Catatan terkait transaksi

Contoh Payload Webhook – Stok Masuk 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 – Pindah 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) adalah diedit.

WajibWajib

Kolom	Wajib	Deskripsi
id		ID unik transaksi
type		Jenis transaksi (in, out, adjust, move)
Mitra		Mitra
partner.id		ID unik mitra
partner.name		Nama mitra
partner.deleted		Apakah mitra dihapus
from_location		Lokasi asal
from_location.id		ID unik lokasi asal
from_location.name		Nama lokasi asal
from_location.deleted		Apakah lokasi asal 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 karena transaksi (in/out/adjust/move)
items.deleted		Apakah item dihapus
items.from_location_new_stock_level		Level stok di lokasi asal setelah transaksi
items.to_location_new_stock_level		Level stok di lokasi tujuan setelah transaksi
transaction_time		Waktu transaksi (misalnya waktu masuk/keluar stok)
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 jumlah perubahan inventaris
url		URL untuk melihat halaman detail transaksi
memo		Catatan terkait transaksi
revisi		Nomor versi saat ini dari transaksi, dimulai dari 1

Contoh Payload Webhook – Transaksi yang Diedit Stok Masuk 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 – Transaksi yang Diedit Pindah 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.

Kolom	Deskripsi
id	ID unik transaksi
revisi	Nomor versi saat ini dari transaksi, dimulai dari 1

Contoh Payload Webhook – Transaksi yang Dihapus

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

item/new

Dikirim saat item baru ditambahkan ke inventaris tim.

Catatan: Event ini adalah bukan dipicu saat menggunakan Fitur Tambah Varian Item atau mengimpor item melalui Impor Excel.

Wajib

Kolom	Deskripsi
id	ID Item
nama	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": "Kategori",
      "type": "text",
      "value": "alas bedak"
    },
    {
      "id": 459264,
      "name": "Tanggal kedaluwarsa",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Stok pengaman",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

Dikirim saat item yang sudah ada diedit.

Catatan: Event ini adalah bukan dipicu fatau pengeditan massal yang dilakukan melalui Pusat Data > Item atau melalui Impor Excel fungsi.

Wajib

Kolom	Deskripsi
id	ID Item
nama	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": "Kategori",
      "type": "text",
      "value": "alas bedak"
    },
    {
      "id": 459264,
      "name": "Tanggal kedaluwarsa",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Stok pengaman",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

Dikirim saat item dihapus dari inventaris tim.

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

Kolom	Deskripsi
id	ID Item

Contoh Payload – Item Dihapus

{
  "id": 26122826
}