主页 > API > 获取Webhook列表


获取Webhook列表

/v1/webhooks
  • URL

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

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -l https://api.worktile.com/v1/webhooks?pid=xxx&access_token=xxx
    
  • HTTP请求参数

    参数 必选 类型 说明
    pid false string 项目pid,如果传pid则获取的是项目的Webhook,不传获取个人的Webhook
    access_token true string OAuth授权后获得,请求时可放在header中
  • 返回数据

    示例

    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 401 Unauthorized

    { "error_code":100005, "error_message":"未授权,请授权后再操作", "request":"/v1/user/profile" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权,请授权后再操作 401
    100006 access_token不正确 400