Lewati ke konten

Referensi payload webhook

Body JSON yang di-POST Timemark untuk event Foto baru, field demi field.


Anda sedang menulis endpoint yang menerima webhook Timemark dan perlu tahu bentuk pasti dari body permintaan agar bisa mem-parsingnya.

Setiap pengiriman adalah HTTP POST dengan body JSON. Body ini membawa event dan foto yang terkait. Endpoint Anda harus mengembalikan respons 2xx dalam batas waktu; selain itu dianggap sebagai pengiriman gagal dan akan dicoba ulang.

Ini adalah body yang dikirim untuk event Foto baru (event_type: "photo.uploaded"):

{
"event_type": "photo.uploaded",
"event_id": "3f4566da-938d-4e11-834b-ba9e3faec98c",
"group_name": "Group Scenery",
"project_name": "Project Sunrise",
"photo_code": "A1BCDEFGHIJ23K",
"photo_name": "2025-12-11 13.45.00_1388 Central Park, New York, example.jpg",
"photo_url": "https://example.com/uploads/photos/123456.jpg",
"thumbnail_url": "https://example.com/uploads/photos/123456.jpg",
"photo_timestamp": "2025-12-11T13:45:00Z",
"photo_location": {
"location_name": "Central Park, New York, USA",
"location_latitude": "40.785091",
"location_longitude": "-73.968285"
},
"member": {
"member_name": "Alice Chen",
"member_short_name": "Alice",
"member_profile_picture_url": "https://example.com/user/profile_photo/123456.jpg",
"member_contact": "alice.chen@example.com"
},
"device_model": "Apple iPhone 14 Pro Max",
"custom_notes": [
{
"title": "custom_note_title_1",
"content": "custom_note_content_1"
},
{
"title": "custom_note_title_2",
"content": "custom_note_content_2"
}
]
}
FieldTipeDeskripsi
event_typestringEvent yang terpicu. photo.uploaded untuk event Foto baru.
event_idstringID unik untuk pengiriman ini. Gunakan untuk menghindari duplikasi saat percobaan ulang.
group_namestringTim tempat foto ini berasal.
project_namestringProyek tempat foto ini berasal.
photo_codestringKode verifikasi foto, juga digunakan di Photo Verification Center.
photo_namestringNama file foto, termasuk waktu dan lokasi pengambilannya.
photo_urlstringURL gambar ukuran penuh.
thumbnail_urlstringURL gambar thumbnail.
photo_timestampstringWaktu pengambilan dalam format ISO 8601 (UTC).
photo_locationobjectLokasi pengambilan. Lihat di bawah.
photo_location.location_namestringNama tempat atau alamat yang mudah dibaca.
photo_location.location_latitudestringLatitude, dalam bentuk string.
photo_location.location_longitudestringLongitude, dalam bentuk string.
memberobjectAnggota yang mengambil foto. Lihat di bawah.
member.member_namestringNama tampilan lengkap.
member.member_short_namestringNama singkat.
member.member_profile_picture_urlstringURL foto profil anggota.
member.member_contactstringKontak anggota, seperti email.
device_modelstringPerangkat yang mengambil foto.
custom_notesarrayCatatan khusus pada foto. Setiap item memiliki title dan content.
  • Latitude dan longitude berupa string, bukan angka. Lakukan cast sebelum melakukan perhitungan matematis.
  • Hindari duplikasi berdasarkan event_id. Pengiriman yang dicoba ulang menggunakan event_id yang sama, jadi simpan nilainya dan lewati duplikat.
  • Konfirmasi cepat, proses belakangan. Kembalikan 2xx terlebih dahulu, baru lakukan pekerjaan berat, atau pengiriman akan dianggap gagal dan dicoba ulang.

Terakhir diperbarui: