Get Webhook

Function

To retrieve a specific subscribed webhook by id
以id獲取一個已訂閱的webhook

URL

GET <<api_domain>>/v1/webhooks/:id

Request parameters

Parameter	Type	Description	Example
:id *required	`String`	Webhook ID	`5f8e5dc08a8bb70a5c9cd93c`

Response fields

Field	Type	Description	Example
id	`String`	Webhook ID	`5f8e5dc08a8bb70a5c9cd93c`
format	`String`	Webhook format Webhook格式 --- Currently support "json" only 現只支援"json"	`json`
address	`String`	URL to receive the webhook 接收Webhook的URL	`http://abc.com/webhooks`
status	`String`	Webhook status Webhook狀態 --- - active - removed	`active`
merchant_id	`String`	Merchant ID 商户ID	`5e840cae77cb07003243f7c7`
created_at	`DateTime`	Webhook created time Webhook創建日期	`2020-10-20T03:50:00.323+00:00`
updated_at	`DateTime`	Webhook Updated Time Webhook更新時間	`2020-10-23T08:43:00.369+00:00`
topics	`String[]`	Events that trigger the webhook 誘發webhook的事件 --- Topic lists 可以訂閱的 topic 清單	`order/create`

Response example

{
    "id": "5f8e5dc08a8bb70a5c9cd93c",
    "format": "json",
    "address": "http://abc.com/webhooks",
    "status": "active",
    "merchant_id": "5e840cae77cb07003243f7c7",
    "created_at": "2020-10-20T03:50:00.323+00:00",
    "updated_at": "2020-10-23T08:43:00.369+00:00",
    "topics": [
        "order/create"
    ]
}

Webhook payload 請參考此頁 Webhook Topic and Payload Example