WebHook
Callback Status Email
URL
Diisi sesuai kebutuhan pengguna pada halaman
Diisi sesuai kebutuhan pengguna pada halaman
Tampilkan blok kode ini di jendela mengambang
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang
Metode Permintaan HTTP
post
post
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| X-WebHook-Timestamp | String | ya | timestamp |
| X-WebHook-AppKey | String | ya | nilai tetap: “email” |
| X-WebHook-Signature | String | ya | tanda tangan digital |
Body Permintaan
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_id | string | id pesan |
| from | string | pengirim (kosong pada pesan target) |
| subject | string | subjek (kosong pada pesan target) |
| to | string | penerima (kosong pada pesan target) |
| server | string | |
| itime | long | timestamp pembuatan pesan |
| custom_args | json | field yang didefinisikan pelanggan |
| status | json | status callback pesan |
Tips:
- Algoritma tanda tangan: gunakan app key pengguna sebagai kunci enkripsi untuk melakukan operasi HmacSHA256 pada waktu timestamp guna memperoleh karakter heksadesimal.
Status Target Email
Kondisi: Permintaan email berhasil.
status
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_status | string | target |
| status_data | objek json | data status |
| message | string | permintaan berhasil |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| from | string | pengirim |
| subject | string | subjek |
| tos | array | array penerima |
| email_ids | array | array id email penerima |
| label_id | int | id label |
Status Email Terkirim
Kondisi: Email berhasil dikirim dari EngageLab.
status
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_status | string | sent |
| status_data | objek json | data status |
| message | string | berhasil dikirim |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
Status Email Diterima Penerima
Kondisi: Email berhasil diterima oleh penerima.
status
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_status | string | delivered |
| status_data | objek json | data status |
| message | string | berhasil diterima |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
Status Email invalid_email
Kondisi: Pengiriman email gagal.
status
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_status | string | invalid_email |
| status_data | objek json | data status |
| error_code | int | kode error |
| error_detail | json | detail error |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
| message | string | log pengembalian mailbox |
| sub_stat | int | subkategori error (4xx: email tidak valid) |
| sub_stat_desc | string | deskripsi subkategori error |
Status Email soft_bounce
Kondisi: Email sampai ke server penerima namun dikembalikan.
status
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_status | string | soft_bounce |
| status_data | objek json | data status |
| error_code | int | kode error |
| error_detail | json | detail error |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
| message | string | log pengembalian mailbox |
| sub_stat | int | subkategori error (5xx: soft bounce) |
| sub_stat_desc | string | deskripsi subkategori error |
Callback Respons Email
URL
Diisi sesuai kebutuhan pengguna pada halaman
Diisi sesuai kebutuhan pengguna pada halaman
Tampilkan blok kode ini di jendela mengambang
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang
Metode Permintaan HTTP
post
post
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| X-WebHook-Timestamp | String | ya | timestamp |
| X-WebHook-AppKey | String | ya | nilai tetap: “email” |
| X-WebHook-Signature | String | ya | tanda tangan digital |
Body Permintaan
| Parameter | Tipe | Deskripsi |
|---|---|---|
| message_id | string | id pesan |
| from | string | pengirim (kosong pada pesan route) |
| subject | string | subjek (kosong pada pesan route) |
| to | string | penerima |
| server | string | |
| itime | long | timestamp pembuatan pesan |
| custom_args | json | field yang didefinisikan pelanggan |
| response | json | respons callback pesan |
Tips:
- Algoritma tanda tangan: gunakan app key pengguna sebagai kunci enkripsi untuk melakukan operasi HmacSHA256 pada waktu timestamp guna memperoleh karakter heksadesimal.
Respons Email Dibuka
Kondisi: Penerima membuka email.
response
| Parameter | Tipe | Deskripsi |
|---|---|---|
| event | string | open |
| response_data | objek json | data respons |
| message | string | email dibuka |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
| ip | string | IP operasi |
| explorer_name | string | nama browser |
| explorer_ver | string | versi browser |
| os_name | string | nama OS |
| os_ver | string | versi OS |
Respons Klik Email
Kondisi: Penerima mengklik tautan dalam email.
response
| Parameter | Tipe | Deskripsi |
|---|---|---|
| event | string | click |
| response_data | objek json | data respons |
| message | string | email diklik |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
| url | string | url klik |
| ip | string | IP operasi |
| explorer_name | string | nama browser |
| explorer_ver | string | versi browser |
| os_name | string | nama OS |
| os_ver | string | versi OS |
Respons Unsubscribe Email
Kondisi: Penerima klik berhenti berlangganan.
response
| Parameter | Tipe | Deskripsi |
|---|---|---|
| event | string | unsubscribe |
| response_data | objek json | data respons |
| message | string | berhenti berlangganan email |
| task_id | int | id tugas |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
| ip | string | IP operasi |
| explorer_name | string | nama browser |
| explorer_ver | string | versi browser |
| os_name | string | nama OS |
| os_ver | string | versi OS |
Respons Email Dilaporkan Spam
Kondisi: Penerima melaporkan email sebagai spam.
response
| Parameter | Tipe | Deskripsi |
|---|---|---|
| event | string | report_spam |
| response_data | objek json | data respons |
| api_user | string | pengguna api |
| email_id | string | id email |
| label_id | int | id label |
Respons Route Email
Kondisi: Penerima membalas atau mengirim ke route penerimaan.
response
| Parameter | Tipe | Deskripsi |
|---|---|---|
| event | string | route |
| response_data | objek json | data respons |
| message | string | route mx |
| html | string | html email |
| text | string | teks email |
| headers | string | header email route |
| from_name | string | nama pengirim |
| subject | string | subjek email |
| from | string | alamat pengirim |
| reference | string | referensi |
| email_id | string | id email |
| raw_message | string | pesan mentah |
| raw_message_url | string | url unduhan pesan mentah |
| x_mx_mailfrom | string | x_mx_mailfrom |
| x_mx_rcptto | string | x_mx_rcptto |
| label_id | int | id label |
