{"_id":"572bacc980b61a0e006afdcf","project":"54da5d2f5b80b62300dadc4e","__v":11,"category":{"_id":"572b89f0b352ab0e003daca2","project":"54da5d2f5b80b62300dadc4e","__v":0,"version":"54da5d305b80b62300dadc51","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-05T17:59:12.339Z","from_sync":false,"order":1,"slug":"webhooks","title":"Webhooks"},"version":{"_id":"54da5d305b80b62300dadc51","project":"54da5d2f5b80b62300dadc4e","__v":7,"createdAt":"2015-02-10T19:34:08.062Z","releaseDate":"2015-02-10T19:34:08.062Z","categories":["54da5d305b80b62300dadc52","54da704b11dfeb1900430309","54da705c44b1090d00072b34","54db48c86db3861700c840c5","54db48cd7dadb32300511364","54dbaa0c7dadb3230051143b","572b89f0b352ab0e003daca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1.0","version_clean":"1.0.0","version":"1"},"parentDoc":null,"user":"54da5cb85b80b62300dadc4b","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-05T20:27:53.989Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \\n\\nEsta documentação é referente à API da plataforma Clicksign Classic.\",\n  \"title\": \"Utilize a nova plataforma de assinatura\"\n}\n[/block]\nAtravés desta requisição, você poderá obter a listagem de todos os *webhooks* cadastrados no documento.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Method\",\n    \"1-0\": \"Path\",\n    \"0-1\": \"`GET`\",\n    \"1-1\": \"`/v1/documents/:key/hooks?access_token=string`\\n\\n`:key` deve ser substituída pela key do documento. Exemplo: `88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3`\",\n    \"2-0\": \"Headers\",\n    \"2-1\": \"`Content-Type: application/json`\\n\\n`Accept: application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Exemplo\n### Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v1/documents/88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3/hooks?access_token=string HTTP/1.1\\nHost: api.clicksign-demo.com\\nAccept: application/json\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"\"\n    }\n  ]\n}\n[/block]\n### Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 200 OK\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": null\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"id\\\": 226613,\\n    \\\"url\\\": \\\"http://www.example.com/documents\\\",\\n    \\\"created_at\\\": \\\"2015-02-12T13:27:51.307-02:00\\\",\\n    \\\"updated_at\\\": \\\"2015-02-12T13:27:51.307-02:00\\\"\\n  }\\n]\",\n      \"language\": \"json\",\n      \"name\": \"Body\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"listagem-de-webhooks","type":"basic","title":"Listagem de Webhooks"}

Listagem de Webhooks


[block:callout] { "type": "danger", "body": "Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \n\nEsta documentação é referente à API da plataforma Clicksign Classic.", "title": "Utilize a nova plataforma de assinatura" } [/block] Através desta requisição, você poderá obter a listagem de todos os *webhooks* cadastrados no documento. [block:parameters] { "data": { "0-0": "Method", "1-0": "Path", "0-1": "`GET`", "1-1": "`/v1/documents/:key/hooks?access_token=string`\n\n`:key` deve ser substituída pela key do documento. Exemplo: `88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3`", "2-0": "Headers", "2-1": "`Content-Type: application/json`\n\n`Accept: application/json`" }, "cols": 2, "rows": 3 } [/block] ## Exemplo ### Request [block:code] { "codes": [ { "code": "GET /v1/documents/88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3/hooks?access_token=string HTTP/1.1\nHost: api.clicksign-demo.com\nAccept: application/json\nContent-Type: application/json", "language": "http", "name": "" } ] } [/block] ### Response [block:code] { "codes": [ { "code": "HTTP/1.1 200 OK\nContent-Type: application/json", "language": "http", "name": null } ] } [/block] [block:code] { "codes": [ { "code": "[\n {\n \"id\": 226613,\n \"url\": \"http://www.example.com/documents\",\n \"created_at\": \"2015-02-12T13:27:51.307-02:00\",\n \"updated_at\": \"2015-02-12T13:27:51.307-02:00\"\n }\n]", "language": "json", "name": "Body" } ] } [/block]