主页 > 文档


文档


  • 新建文档

    发出的数据格式

    Header信息

    {
        "User-Agent"         : "Worktile-WebHook-Server",
        "X-Worktile-Delivery": "a3l0s9h3aloyh",
        "X-Worktile-Event"   :  "create_page",
        "Content-Type"       : "application/json"
    }
    

    Body信息

    {
        "action": "create_page", //事件类型
        "data"  : {
            "page_id"    : "page_id", //文档ID
            "name"       :  "name", //文档名称
            "summary"    : "文档描述", //文档描述
            "content"    : "content", //文档内容
            "create_date": 14109373736,//创建时间
            "versions"   : [{
                               "version": 1,//版本号
                               "message":"创建文档 11111", //该版本记录
                               "content": "111111", //该版本内容
                               "create_date": 14109373736,//该版本时间
                             }
                            ],
            "version"    : 1, //当前版本号
            "create_by"  : {
                "uid"         : "uid",//创建者ID
                "name"        : "name",//创建者用户名
                "display_name": "display_name",//创建者昵称
                "email"       : "email"//创建者邮箱
            },
            "project"    : {
                "pid" : "pid",//项目ID
                "name": "name"//项目名称
            }
        }
    }
    
  • 文档编辑

    发出的数据格式

    Header信息

    {
        "User-Agent"         : "Worktile-WebHook-Server",
        "X-Worktile-Delivery": "a3l0s9h3aloyh",
        "X-Worktile-Event"   :  "page_version",
        "Content-Type"       : "application/json"
    }
    

    Body信息

    {
        "action": "page_version", //事件类型
        "data"  : {
            "page_id"    : "page_id", //文档ID
            "name"       :  "name", //文档名称
            "summary"    : "文档描述", //文档描述
            "content"    : "content", //文档内容
            "create_date": 14109373736,//创建时间
            "versions"   : [
                               {
                               "version": 1,//版本号
                               "message":"创建文档 11111", //该版本记录
                               "content": "111111", //该版本内容
                               "create_date": 14109373736,//该版本时间
                             },
                             {
                               "version": 2,//版本号
                               "message":"修改文档 22222", //该版本记录
                               "content": "222222", //该版本内容
                               "create_date": 14109373736,//该版本时间
                             }
                            ],
            "version"    : 2, //当前版本号
            "create_by"  : {
                "uid"         : "uid",//创建者ID
                "name"        : "name",//创建者用户名
                "display_name": "display_name",//创建者昵称
                "email"       : "email"//创建者邮箱
            },
            "project"    : {
                "pid" : "pid",//项目ID
                "name": "name"//项目名称
            }
        }
    }
    
  • 发起评论

    发出的数据格式

    Body信息

    { "action": "comment_page", //事件类型
     "data": {
          "page_id": "f035c3cafed2"',//文档id
          "name":"webhook测试",//文档名称(标题)
          "content":"文档内容",//文档内容
          "summary":"文档内容",//文档内容
          "create_date": 1410775277425,//文档的创建时间
          "comment":  {
                   "cid": "fdd91b21",//评论id
                   "message": "发表评论",//评论内容
                   "create_date": 1428030725616,//评论时间
                   "create_by":{
                           "uid":"679efdf5ff",//评论者id
                           "name":"gonglinjie",//评论者用户名
                           "display_name":"龚林杰"//评论者昵称
                       },
           "project": {
                          "pid": "9a6aeeeb",//项目id
                          "name": "熟悉 Worktile"//项目名称
                      }
       }
    }