{"_id":"572bb11e7c8eff0e00aaa0ab","project":"54da5d2f5b80b62300dadc4e","user":"54da5cb85b80b62300dadc4b","githubsync":"","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"},"__v":89,"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"},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-05T20:46:22.568Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"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]\n*Webhooks* permitem criar integrações que subscrevem a eventos nos documentos da Clicksign. Quando um eventos ocorre, notificamos imediatamente a sua aplicação através de uma requisição `HTTP POST` para a URL cadastrada. Com *Webhooks* sua aplicação não precisa ficar executando *pollings* (consultas de tempos em tempos) na API da Clicksign, ela é acionada automaticamente quando houver um novo evento no documento.\n\nEventos que disparam o *webhook*:\n * Documento termina de ser processado pela Clicksign\n * Lista de assinatura é criada\n * Documento é assinado\n * Documento é cancelado\n\nQuando um documento disparar um evento que aciona o *webhoook*, a Clicksign irá realizar um `HTTP POST` para a `url` que foi cadastrada no documento, e no *body* da requisição irá a chave do documento em formato `JSON`. Por segurança, a Clicksign nunca envia mais informações do que a chave do documento. Você deverá fazer uma nova requisição de [Visualização](doc:visualizacao) para conferir a alteração.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Disparo de evento do Webhook\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Method\",\n    \"1-0\": \"Path\",\n    \"2-0\": \"Headers\",\n    \"0-1\": \"`POST`\",\n    \"2-1\": \"`Content-Type: application/json`\",\n    \"1-1\": \"**URL cadastrada** \\n\\n`http://www.example.com/documents`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"document\\\": {\\n    \\\"key\\\": \\\"88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Body\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Protegendo os Webhooks\"\n}\n[/block]\nPara a Clicksign se comunicar com a sua aplicação, você precisará de uma URL publica acessível. Sugerimos que a URL seja protegida para que requisições maliciosas não possam manipular seus dados.\n\n**Requisições HTTPS**\nPara garantir que os dados estejam criptografados, sugerimos fortemente a utilização de `HTTPS` na URL do seu *webhook*.\n\n**Autenticação básica HTTP**\nQuase todos os servidores web podem ser configurados para utilizarem autenticação básica HTTP requerendo usuário e senha para acessar uma URL. Você pode configurar sua URL do *webhook* passando usuário e senha através da URL. Por exemplo, a URL `https://example.com/webhook` passará para `https://<username>:<password>:::at:::example.com/webhook`.\n\n**Restrição de IPs no firewall**\nSe você estiver utilizando um firewall, poderá configurá-lo para aceitar apenas requisições dos IPs dos *webhooks* da Clicksign.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Ambiente\",\n    \"h-1\": \"IP Fixo para disparo dos webhooks\",\n    \"h-2\": \"\",\n    \"0-0\": \"Produção\",\n    \"0-1\": \"54.88.43.182\",\n    \"1-0\": \"Desenvolvimento e demonstração (Sandbox)\",\n    \"1-1\": \"52.45.176.176\",\n    \"0-2\": \"\",\n    \"1-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tentativas de disparo de Webhook\"\n}\n[/block]\nA Clicksign realiza 7 tentativas de envio da requisição na URL cadastrada. Assim, um *webhook* é perdido somente se a URL cadastrada estiver indisponível por mais de 15 horas.\n\n**Tentativas de disparo:**\nTentativa 1: Momento em que ocorre o evento.\nTentativa 2: 00:00:06\nTentativa 3: 00:00:42\nTentativa 4: 00:04:12\nTentativa 5: 00:25:12\nTentativa 6: 02:31:12\nTentativa 7: 15:07:12","excerpt":"","slug":"visao-geral-dos-webhooks","type":"basic","title":"Visão geral dos Webhooks"}

Visão geral dos 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] *Webhooks* permitem criar integrações que subscrevem a eventos nos documentos da Clicksign. Quando um eventos ocorre, notificamos imediatamente a sua aplicação através de uma requisição `HTTP POST` para a URL cadastrada. Com *Webhooks* sua aplicação não precisa ficar executando *pollings* (consultas de tempos em tempos) na API da Clicksign, ela é acionada automaticamente quando houver um novo evento no documento. Eventos que disparam o *webhook*: * Documento termina de ser processado pela Clicksign * Lista de assinatura é criada * Documento é assinado * Documento é cancelado Quando um documento disparar um evento que aciona o *webhoook*, a Clicksign irá realizar um `HTTP POST` para a `url` que foi cadastrada no documento, e no *body* da requisição irá a chave do documento em formato `JSON`. Por segurança, a Clicksign nunca envia mais informações do que a chave do documento. Você deverá fazer uma nova requisição de [Visualização](doc:visualizacao) para conferir a alteração. [block:api-header] { "type": "basic", "title": "Disparo de evento do Webhook" } [/block] [block:parameters] { "data": { "0-0": "Method", "1-0": "Path", "2-0": "Headers", "0-1": "`POST`", "2-1": "`Content-Type: application/json`", "1-1": "**URL cadastrada** \n\n`http://www.example.com/documents`" }, "cols": 2, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "{\n \"document\": {\n \"key\": \"88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3\"\n }\n}", "language": "json", "name": "Body" } ] } [/block] [block:api-header] { "type": "basic", "title": "Protegendo os Webhooks" } [/block] Para a Clicksign se comunicar com a sua aplicação, você precisará de uma URL publica acessível. Sugerimos que a URL seja protegida para que requisições maliciosas não possam manipular seus dados. **Requisições HTTPS** Para garantir que os dados estejam criptografados, sugerimos fortemente a utilização de `HTTPS` na URL do seu *webhook*. **Autenticação básica HTTP** Quase todos os servidores web podem ser configurados para utilizarem autenticação básica HTTP requerendo usuário e senha para acessar uma URL. Você pode configurar sua URL do *webhook* passando usuário e senha através da URL. Por exemplo, a URL `https://example.com/webhook` passará para `https://<username>:<password>@example.com/webhook`. **Restrição de IPs no firewall** Se você estiver utilizando um firewall, poderá configurá-lo para aceitar apenas requisições dos IPs dos *webhooks* da Clicksign. [block:parameters] { "data": { "h-0": "Ambiente", "h-1": "IP Fixo para disparo dos webhooks", "h-2": "", "0-0": "Produção", "0-1": "54.88.43.182", "1-0": "Desenvolvimento e demonstração (Sandbox)", "1-1": "52.45.176.176", "0-2": "", "1-2": "" }, "cols": 2, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Tentativas de disparo de Webhook" } [/block] A Clicksign realiza 7 tentativas de envio da requisição na URL cadastrada. Assim, um *webhook* é perdido somente se a URL cadastrada estiver indisponível por mais de 15 horas. **Tentativas de disparo:** Tentativa 1: Momento em que ocorre o evento. Tentativa 2: 00:00:06 Tentativa 3: 00:00:42 Tentativa 4: 00:04:12 Tentativa 5: 00:25:12 Tentativa 6: 02:31:12 Tentativa 7: 15:07:12