WebHook管理

WebHookは、EngageLabが関心のあるイベントに関するデータを顧客が提供するコールバックURLに非同期的にプッシュするためのメカニズムです。

APIを使用して、コールバックURLのクエリ、追加、更新、削除を行うことができます。

クエリ

URL

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

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

このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET

GET

このコードブロックはフローティングウィンドウ内に表示されます

ヘッダー

ヘッダー	タイプ	必須	説明
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

このコードブロックはフローティングウィンドウ内に表示されます

ヘッダー

ヘッダー	タイプ	必須	説明
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 Request Method

PUT

PUT

このコードブロックはフローティングウィンドウ内に表示されます

ヘッダー

ヘッダー	タイプ	必須	説明
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 Request Method

DELETE

              
              DELETE

このコードブロックはフローティングウィンドウ内に表示されます

ヘッダー

ヘッダー	タイプ	必須	説明
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
}

このコードブロックはフローティングウィンドウ内に表示されます