主页 > API > 添加项目的Webhook


添加项目的Webhook

/v1/webhook
  • URL

    https://api.worktile.com/v1/webhook

  • HTTP请求方式

    POST

  • 支持格式

    JSON

    Header参数

    {
       "Content-Type":"application/json",
       "access_token":"xxx"
    }
    

    示例

    curl -d 'name=名称&actions=['create_task']&web_hook_url=http://webhook.com/webhook' 'https://api.worktile.com/v1/webhook?pid=xxx&access_token=xxx' 
    
  • HTTP请求参数

    参数 必选 类型 说明
    pid true string 项目pid
    access_token true string OAuth授权后获得,请求时可放在header中
    name true string Webhook名称
    actions false array 事件数组(create_task,complete_task,expire_task,create_event,create_page,page_version,pick_comment,pick_post)
    web_hook_url true string Webhook的url
  • 返回数据

    示例

    HTTP/1.1 200 ok

    { "wid":"xafdfasdf", "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "uid":"890a7e8dc3e24b87ac376ffa82a75460", "name":"名称", "web_hook_url":"http://webhook.com/webhook", "created_at":"2015-03-23T09:43:42.863Z", "updated_at":"2015-03-23T09:43:42.863Z", "actions":[ "create_task" ], "is_every":0, "type":0 }


    返回值字段 类型 说明
    wid string Webhook的wid
    pid string 项目pid
    uid string 设置Webhook的用户uid
    name string Webhook的名称
    web_hook_url string Webhook的url
    created_at string 创建时间
    updated_at string 更新时间
    actions array 项目Webhook的事件类型
    is_every number 判断是否所有事件:1:代表所有事件,0:代表部分事件,如actions数组长度大于1
    type number 类型:0:代表项目,1:代表个人
  • 异常结果

    示例

    HTTP/1.1 400 Bad Request

    { "error_code":130001, "error_message":"webhook url 不能为空", "request":"/v1/webhook" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 没授权,请授权后再操作 401
    100006 access_token不正确 400
    130001 webhook url 不能为空 400
    130002 添加webhook失败 500