WebHooks API

Webhook adalah mekanisme bagi EngageLab untuk secara asinkron mengirimkan data terkait peristiwa tertentu ke URL callback milik pelanggan.

Anda dapat menggunakan API untuk menampilkan, menambah, memperbarui, dan menghapus URL callback.

Alamat Endpoint

Data Center	URL
Singapura	https://email.api.engagelab.cc
Turki	https://emailapi-tr.engagelab.com

Pastikan data center yang dipilih sesuai dengan base URL saat menggunakan REST API.

POST /v1/webhooks

Query

URL

https://email.api.engagelab.cc/v1/webhooks

              
              https://email.api.engagelab.cc/v1/webhooks

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
api_user	string	tidak	API_USER terkait
offset	int	tidak	posisi awal, [0-], default 0
limit	int	tidak	jumlah, [0-100], default 100

Contoh Permintaan:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/webhooks?api_user=abcd&offset=0&limit=1'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/webhooks?api_user=abcd&offset=0&limit=1'

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik:

{ "result": [ { "url": "http://qxxx.com", "event": [1,3], "api_user": "my_test", "id": 168 } ], "count": 1, "total": 2 }

              
              {
    "result": [
        {
            "url": "http://qxxx.com",
            "event": [1,3],
            "api_user": "my_test",
            "id": 168
        }
    ],
    "count": 1,
    "total": 2
}

Tampilkan blok kode ini di jendela mengambang

Tambah

URL

https://email.api.engagelab.cc/v1/webhooks

              
              https://email.api.engagelab.cc/v1/webhooks

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
url	string	ya	URL tujuan di mana event webhook akan mengirimkan data event
api_user	string	tidak	API_USER terkait, default untuk semua api_user
event	array	tidak	Tipe event, contoh: [1,3]. Default untuk semua event

Daftar event umum

Parameter	Event	Kondisi Pemicu
1	deliver	Email berhasil dikirim
3	report_spam	Pengguna melaporkan email sebagai spam
4	invalid_email	Email gagal dikirim
5	soft_bounce	Email ditolak sementara oleh penerima
10	click	Pengguna mengklik tautan
11	open	Pengguna membuka email
12	unsubscribe	Pengguna berhenti berlangganan email
18	request	Permintaan email berhasil (termasuk terkirim/terkirim ulang)
32	sent	Email berhasil dikirim

Contoh Permintaan:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"url": "123456","api_user":"qq.com", "event":[1,3]}' \ 'https://email.api.engagelab.cc/v1/webhooks'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"url": "123456","api_user":"qq.com", "event":[1,3]}' \
     'https://email.api.engagelab.cc/v1/webhooks'

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik:

{ "result": [ { "url": "http://qxxx.com", "event": [1,3], "api_user": "my_test", "id": 167 } ] }

              
              {
    "result": [
        {
            "url": "http://qxxx.com",
            "event": [1,3],
            "api_user": "my_test",
            "id": 167
        }
    ]
}

Tampilkan blok kode ini di jendela mengambang

Ubah

URL

https://email.api.engagelab.cc/v1/webhooks/{id}

              
              https://email.api.engagelab.cc/v1/webhooks/{id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(api_user:api_key)

Deskripsi Parameter Body

Parameter	Tipe	Wajib	Deskripsi
url	string	tidak	URL callback, jika tidak diisi, tidak diubah
api_user	string	tidak	API_USER terkait, jika tidak diisi, tidak diubah
event	array	tidak	Tipe event, contoh: [1,3], jika tidak diisi, tidak diubah

Contoh Permintaan:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ --data '{"url": "http://example2.com"}' \ 'https://email.api.engagelab.cc/v1/webhooks/1111111'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     --data '{"url": "http://example2.com"}' \
     'https://email.api.engagelab.cc/v1/webhooks/1111111'

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik:

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://email.api.engagelab.cc/v1/webhooks/{id}

              
              https://email.api.engagelab.cc/v1/webhooks/{id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(api_user:api_key)

Contoh Permintaan

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \ -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \ 'https://email.api.engagelab.cc/v1/webhooks/1111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' \
     'https://email.api.engagelab.cc/v1/webhooks/1111111'

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang