--- title: "订阅 Webhook" description: > 订阅指定的 Webhook 事件，例如商品创建或订单更新等。你必须提供一个 URL 用于应用接收事件通知。 :::warning **注意**：该 API 仅支持订阅 v20240601 及更高版本的 Webhook 事件。 对于更早版本的 Webhook 事件，通过如下方式进行管理： - 公共应用和自定义应用：进入 [SHOPLINE 合作伙伴后台](https://developer.myshopline.com/)，前往 **应用** > **Webhook 配置**。 - 私有应用：进入 [SHOPLINE 商家后台](https://admin.myshopline.com/user/signIn) ，前往**应用** > **开发应用** > **编辑** > **权限配置**。 ::: doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/webhook/subscribe-to-a-webhook' md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/webhook/subscribe-to-a-webhook.md' --- # 订阅 Webhook 订阅指定的 Webhook 事件，例如商品创建或订单更新等。你必须提供一个 URL 用于应用接收事件通知。 :::warning **注意**：该 API 仅支持订阅 v20240601 及更高版本的 Webhook 事件。 对于更早版本的 Webhook 事件，通过如下方式进行管理： - 公共应用和自定义应用：进入 [SHOPLINE 合作伙伴后台](https://developer.myshopline.com/)，前往 **应用** > **Webhook 配置**。 - 私有应用：进入 [SHOPLINE 商家后台](https://admin.myshopline.com/user/signIn) ，前往**应用** > **开发应用** > **编辑** > **权限配置**。 ::: - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http POST /webhooks.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。 ## Request ### Request Headers * `Content-Type` string (required) 字段值固定为 `application/json; charset=utf-8`。 * `Authorization` string (required) 资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。 ### Request Body * `webhook` object Webhook 事件订阅的配置信息。 * `address` string 接收事件通知的回调 URL 地址。平台将在相关事件发生时，将事件数据推送到此地址。 最大长度限制：255 * `api_version` string Webhook 事件的版本号，仅支持 `v20240601` 及更高的版本。 * `topic` string 订阅的具体事件，如 `products/create` 表示“商品创建”事件。目前每次调用只能订阅一个事件，不支持传入多个事件标识。事件标识符可通过对应的 [webhook 文档](https://developer.shopline.com/zh-hans-cn/docs/webhook/product/product-created.md) 找到。 ## Response ### Status Codes * `200` 更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。 * `401` * `429` ### Response Headers * `traceId` 请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。 ### Response Body #### 200 * `webhook` object Webhook 事件订阅的配置信息。 * `address` string 应用接收 Webhook 事件通知的 URL 地址。 * `api_version` string Webhook 事件的版本号。 * `created_at` string 首次成功订阅该 Webhook 事件的日期与时间。格式：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)。 * `id` integer 订阅记录的唯一标识符。 * `topic` string 已成功订阅的具体事件，如 `products/create` 表示“商品创建”事件。 * `updated_at` string Webhook 订阅记录最近一次更新的日期和时间。格式：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)。 #### 401 * `errors` string 错误描述。 #### 429 * `errors` string 错误描述。 ## OpenAPI Definition ```json { "tags": [ "订阅 Webhook" ], "description": "订阅指定的 Webhook 事件，例如商品创建或订单更新等。你必须提供一个 URL 用于应用接收事件通知。 \n\n:::warning\n**注意**：该 API 仅支持订阅 v20240601 及更高版本的 Webhook 事件。\n对于更早版本的 Webhook 事件，通过如下方式进行管理：\n- 公共应用和自定义应用：进入 [SHOPLINE 合作伙伴后台](https://developer.myshopline.com/)，前往 **应用** > **Webhook 配置**。\n- 私有应用：进入 [SHOPLINE 商家后台](https://admin.myshopline.com/user/signIn) ，前往**应用** > **开发应用** > **编辑** > **权限配置**。\n:::\n\n", "operationId": "5yxG7lOk", "parameters": [ { "name": "Content-Type", "in": "header", "description": "字段值固定为 `application/json; charset=utf-8`。", "required": true, "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": "资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。", "required": true, "style": "string", "schema": { "name": "Authorization", "description": "资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "requestBody": { "content": { "application/json": { "schema": { "name": "body", "description": "body位置参数", "type": "object", "properties": { "webhook": { "name": "webhook", "description": "Webhook 事件订阅的配置信息。", "type": "object", "properties": { "address": { "name": "address", "description": "接收事件通知的回调 URL 地址。平台将在相关事件发生时，将事件数据推送到此地址。 \n最大长度限制：255", "type": "string", "example": "https://www.shopline.com/webhook" }, "api_version": { "name": "api_version", "description": "Webhook 事件的版本号，仅支持 `v20240601` 及更高的版本。", "type": "string", "example": "v20240601" }, "topic": { "name": "topic", "description": "订阅的具体事件，如 `products/create` 表示“商品创建”事件。目前每次调用只能订阅一个事件，不支持传入多个事件标识。事件标识符可通过对应的 [webhook 文档](https://developer.shopline.com/zh-hans-cn/docs/webhook/product/product-created.md) 找到。\n", "type": "string", "example": "products/create" } }, "required": [ "address", "api_version", "topic" ], "example": { "address": "https://www.shopline.com/webhook", "api_version": "v20240601", "topic": "products/create" } } }, "required": [ "webhook" ], "example": { "webhook": { "address": "https://www.shopline.com/webhook", "api_version": "v20240601", "topic": "products/create" } } }, "examples": { "订阅创建商品事件": { "description": "本示例展示了如何订阅 \"创建商品\" 事件。", "value": { "webhook": { "address": "https://www.shopline.com/webhook", "api_version": "v20240601", "topic": "collect/delete" } } } } } }, "required": true }, "responses": { "200": { "description": "更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。", "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "name": "body", "type": "object", "properties": { "webhook": { "name": "webhook", "description": "Webhook 事件订阅的配置信息。", "type": "object", "properties": { "address": { "name": "address", "description": "应用接收 Webhook 事件通知的 URL 地址。", "type": "string", "example": "https://www.shopline.com/webhook" }, "api_version": { "name": "api_version", "description": "Webhook 事件的版本号。", "type": "string", "example": "v20240601" }, "created_at": { "name": "created_at", "description": "首次成功订阅该 Webhook 事件的日期与时间。格式：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)。", "type": "string", "example": "2024-01-31T18:21:06+08:00" }, "id": { "name": "id", "description": "订阅记录的唯一标识符。", "type": "integer", "example": 13814 }, "topic": { "name": "topic", "description": "已成功订阅的具体事件，如 `products/create` 表示“商品创建”事件。", "type": "string" }, "updated_at": { "name": "updated_at", "description": "Webhook 订阅记录最近一次更新的日期和时间。格式：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)。", "type": "string", "example": "2024-01-31T18:21:06+08:00" } }, "example": { "address": "https://www.shopline.com/webhook", "api_version": "v20240601", "created_at": "2024-01-31T18:21:06+08:00", "id": 13814, "topic": null, "updated_at": "2024-01-31T18:21:06+08:00" } } }, "example": { "webhook": { "address": "https://www.shopline.com/webhook", "api_version": "v20240601", "created_at": "2024-01-31T18:21:06+08:00", "id": 13814, "topic": null, "updated_at": "2024-01-31T18:21:06+08:00" } } }, "examples": { "订阅创建商品事件": { "description": "本示例展示了如何订阅 \"创建商品\" 事件。", "value": { "webhook": { "address": "https://www.shopline.com/webhook", "api_version": "v20240601", "created_at": "2025-02-13T17:01:29+08:00", "id": 45852, "topic": "collect/delete", "updated_at": "2025-02-13T17:01:32+08:00" } } } } } } }, "401": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "post", "path": "/webhooks.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。" } } } ], "info": { "title": "订阅 Webhook", "version": "v20270301" } } ```