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	否	關聯的 API_USER
offset	int	否	起始位置，[0-]，默認為 0
limit	int	否	數量，[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	是	所產生的消息Post到Url。
api_user	string	否	關聯的 API_USER，默認為所有 api_users
event	array	否	事件類型，例如：[1, 3]，默認為所有事件。

一般事件的參數描述

參數	事件	觸發條件
1	deliver	郵件發送成功
3	report_spam	用戶舉報郵件
4	invalid	郵件未成功發送
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	否	回調 URL，如果不傳參，則忽略修改此欄位。
api_user	string	否	關聯的 API_USER，如果不傳參，則忽略修改此欄位。
event	array	否	事件類型，例如：[1, 3]，如果不傳參，則忽略修改此欄位。

請求示例:

curl -X PUT -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 PUT -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/webhooks/{id}

          https://email.api.engagelab.cc/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
}

此代碼塊在浮窗中顯示