การจัดการ WebHook

WebHook เป็นกลไกที่ EngageLab ใช้ในการส่งข้อมูลเกี่ยวกับเหตุการณ์ที่น่าสนใจไปยังลูกค้าแบบอะซิงโครนัสไปยัง URL การเรียกกลับที่ลูกค้ากำหนดไว้

คุณสามารถใช้ API เพื่อสอบถาม เพิ่ม อัปเดต และลบ URL การเรียกกลับได้

การสอบถาม

URL

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

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

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET

GET

โค้ดนี้โชว์เป็นหน้าต่างลอย

Header

Header	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	true	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์การสอบถาม

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
api_user	string	No	API_USER ที่เกี่ยวข้อง
offset	int	No	ตำแหน่งเริ่มต้น, [0-], ค่าเริ่มต้นคือ 0
limit	int	No	จำนวน, [0-100], ค่าเริ่มต้นคือ 100

ตัวอย่างคำขอ:

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'

โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ:

{ "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
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การเพิ่ม

URL

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

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

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST

              
              POST

โค้ดนี้โชว์เป็นหน้าต่างลอย

Header

Header	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	true	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์ในเนื้อหาคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
url	string	Yes	URL ที่ใช้โพสต์ข้อความที่สร้างขึ้น
api_user	string	No	API_USER ที่เกี่ยวข้อง, ค่าเริ่มต้นคือ api_users ทั้งหมด
event	array	No	ประเภทเหตุการณ์ เช่น [1, 3], ค่าเริ่มต้นคือเหตุการณ์ทั้งหมด

คำอธิบายพารามิเตอร์เหตุการณ์ทั่วไป

พารามิเตอร์	เหตุการณ์	เงื่อนไขการกระตุ้น
1	deliver	อีเมลถูกส่งสำเร็จ
3	report_spam	ผู้ใช้รายงานอีเมลว่าเป็นสแปม
4	invalid_email	อีเมลส่งไม่สำเร็จ
5	soft_bounce	ผู้รับปฏิเสธอีเมล
10	click	ผู้ใช้คลิกลิงก์
11	open	ผู้ใช้เปิดอีเมล
12	unsubscribe	ผู้ใช้ยกเลิกการสมัครรับอีเมล
18	request	คำขออีเมลสำเร็จ รวมถึงอีเมลที่ส่งและกำลังส่ง
32	sent	อีเมลถูกส่ง

ตัวอย่างคำขอ:

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'

โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ:

{ "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
            }
        ]
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การอัปเดต

URL

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

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

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

PUT

PUT

โค้ดนี้โชว์เป็นหน้าต่างลอย

Header

Header	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	true	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์ในเนื้อหาคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
url	string	No	URL การเรียกกลับ, หากไม่ได้ระบุ ฟิลด์นี้จะถูกละเว้น
api_user	string	No	API_USER ที่เกี่ยวข้อง, หากไม่ได้ระบุ ฟิลด์นี้จะถูกละเว้น
event	array	No	ประเภทเหตุการณ์ เช่น [1, 3], หากไม่ได้ระบุ ฟิลด์นี้จะถูกละเว้น

ตัวอย่างคำขอ:

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'

โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ:

{ "count":1 }

              
              {
   "count":1   
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การลบ

URL

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

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

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE

              
              DELETE

โค้ดนี้โชว์เป็นหน้าต่างลอย

Header

Header	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	true	Basic base64(api_user:api_key)

ตัวอย่างคำขอ

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'

โค้ดนี้โชว์เป็นหน้าต่างลอย

ตัวอย่างการตอบกลับ

{ "count":1 }

              
              {
    "count":1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย