HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Webhooks

❗️

Notice

Please contact SHOPLINE Merchant Success team to enable this function.
請向SHOPLINE Merchant Success團隊申請開啟此功能。

Functions

To retrieve subscribed webhooks
獲取已訂閱的webhook

URL

GET <<api_domain>>/v1/webhooks

Request parameters

ParameterTypeDescriptionExample
per_pageIntegerNumbers of Orders per Page
每頁顯示 n 筆資料
(Default: 24)
per_page=20
pageIntegerPage Number
頁數
(Default: 1)
page=1

Response fields

FieldTypeDescriptionExample
itemsGet WebhookWebhook Information
Webhook資訊
Please check the link on the left
paginationPaginationPagination
頁面資訊
Please check the link on the left

Response example

{
    "items": [
        {
            "id": "5f8e5dc08a8bb70a5c9cd93c",
            "format": "json",
            "address": "http://simulator.shoplinestg.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"
            ]
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 24,
        "total_count": 1,
        "total_pages": 1
    }
}