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
}

此代码块在浮窗中显示