Skip to content

webhook update config

Description

webhook更新設定檔。

Resource

PATCH /v1/basic/webhook/config

Authorization

採用 OAuth 2.0 Bearer Token,詳細使用流程請參考 Auth Login
僅限益欣內部使用(company_id = '24436074'),由此Token取得驗證Webhook acckey。

Request Body Parameters

Name Type Description
id int webhook 流水號
url string 目標url
client_secret string 客戶端密碼
usable boolean 是否啟用(true/false)
events string[] 啟用事件
available_companies available_company[] 啟用公司

Request Body Parameters - available_company

Name Type Description
id string company_id
name string company

Response Body Parameters - message

Name Type Description
message string 回傳訊息
200:
  • 建立成功

400:
  • 錯誤訊息(查看下方例子)

Request Body Example

{
    "id" : 1,
    "url" : "testurl2",
    "client_secret":"testAccount",
    "usable":true,
    "events": [
        "order.create",
        "order.cancel"
        ],
    "available_companies":[
        {
            "id": "24436074",
            "name": "益欣資訊"
        },
        {
            "id": "test",
            "name": "測試公司"
        }
    ]

}

Response Body Example

Status-Code: 200

{
   "message": "修改成功"
}
Status-Code: 400
{
    "message": "url 此目標已存在,請輸入其他目標位址"
}
{
    "message": "account 帳戶不存在,請確認是否輸入正確"
}
{
    "message": "events 不可為空"
}