GET /webhooks

获取店铺中所有 Webhook

• • limit
  • 可选，返回结果条数
    默认10，最大50
• • page
  • 可选，显示的页码
    默认1
• • since_id
  • 可选，返回大于指定ID的结果
• • topic
  • 可选，Webhook主题

• • 获取店铺中所有 Webhook 列表
  • GET /webhooks

  • {
    "webhooks": [
        {
            "address": "http://www.lavandachen.com/test/private_app_create_product_1",
            "created_at": "2015-07-09T19:55:52.106+08:00",
            "id": 6,
            "topic": "products/create",
            "updated_at": "2015-07-09T19:56:26.040+08:00",
            "content_type": "application/json"
        },
        {
            "address": "http://www.lavandachen.com/test/private_app_update_product",
            "created_at": "2015-07-09T19:56:17.382+08:00",
            "id": 7,
            "topic": "products/update",
            "updated_at": "2015-07-09T19:56:17.382+08:00",
            "content_type": "application/json"
        }
    ]
    }
    

• • 获取指定ID的 Webhook
  • GET /webhooks?ids=6,,7

  • {
    "webhooks": [
        {
            "address": "http://www.lavandachen.com/test/private_app_create_product_1",
            "created_at": "2015-07-09T19:55:52.106+08:00",
            "id": 6,
            "topic": "products/create",
            "updated_at": "2015-07-09T19:56:26.040+08:00",
            "content_type": "application/json"
        },
        {
            "address": "http://www.lavandachen.com/test/private_app_update_product",
            "created_at": "2015-07-09T19:56:17.382+08:00",
            "id": 7,
            "topic": "products/update",
            "updated_at": "2015-07-09T19:56:17.382+08:00",
            "content_type": "application/json"
        }
    ]
    }
    

GET /webhooks/count

获取店铺中 Webhook 总数

• • 获取应用创建 Webhook 总数
  • GET /webhooks/count

  • {
    "count": 2
    }
    

GET /webhooks/#{id}

获取指定ID的 Webhook

• • 获取ID为6的 Webhook
  • GET /webhooks/6

  • {
    "webhook": {
        "address": "http://www.example.com/create_product",
        "created_at": "2015-07-09T19:55:52.106+08:00",
        "id": 6,
        "topic": "products/create",
        "updated_at": "2015-07-27T14:12:12.894+08:00",
        "content_type": "application/json"
    }
    }
    

POST /webhooks

创建新的 Webhook

• • address
  • 接收通知的地址
• • topic
  • 指定事件主题

• • 创建 Webhook
  • POST /webhooks

      {
        "webhook": {
          "address": "http://www.example.com/create_product",
           "topic": "products/create",
           "content_type": "application/json"
        }
      }
    

  • {
    "webhook": {
        "address": "http://www.example.com/create_product",
        "created_at": "2015-07-09T19:55:52.106+08:00",
        "id": 6,
        "topic": "products/create",
        "updated_at": "2015-07-27T14:12:12.894+08:00",
        "content_type": "application/json"
    }
    }
    

• • 缺少topic参数，创建 Webhook 时会返回错误信息
  • POST /webhooks

      {
        "webhook": {
          "address": "http://www.example.com/create_product"
        }
      }
    

  • {
    "code": 422,
    "errors": {
        "topic": [
            "不可为空"
        ]
    }
    }
    

PUT /webhooks/#{id}

修改指定ID的 Webhook

• • address
  • 接收通知的地址
• • topic
  • 指定事件主题

• • 修改id=6对应 Webhook 的address
  • PUT /webhooks/6

      {
        "webhook": {
          "address": "http://www.example.com/create_product_1"
        }
      }
    

  • {
    "webhook": {
        "address": "http://www.example.com/create_product_1",
        "created_at": "2015-07-09T19:55:52.106+08:00",
        "id": 6,
        "topic": "products/create",
        "updated_at": "2015-07-27T14:23:59.729+08:00",
        "content_type": "application/json"
    }
    }
    

DELETE /webhooks/#{id}

删除指定ID的 Webhook。

• • 删除ID为6的 Webhook
  • DELETE /webhooks/6

  • {}