Cadastro de Webhooks via API

📘
Requisição para a criação de signatários na Clicksign. Esta é uma requisição POST para /api/v2/webhooks. No body, deverão ser enviados os atributos dos eventos que deseja receber neste endpoint.

1. Cadastro de endpoint

POST /api/v2/webhooks?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Corpo do body

{
  "endpoint": "https://webhook.site/#!/4e398798-1460-4757-95af-ae15fc56ea59",
  "status": "active",
  "events": [
    "add_image",
    "upload"
  ]
}

Atributo	Descrição	Exemplo
`endpoint`	URL para recebimentos dos eventos de webhooks, Campo obrigatório	https://webhook.site/#!/4e398798-1460-4757-95af-ae15fc56ea59
`status`	definição do status Campo obrigatório	`active` Valor padrão: `active`
`events`	Definição dos eventos deverão ser retornados ao endpoint específico. Campo obrigatório	📘 Requisição para a cri Ver lista completa de eventos em: Eventos ]

Atributo

Descrição

Exemplo

endpoint

URL para recebimentos dos eventos de webhooks,

Campo obrigatório

https://webhook.site/#!/4e398798-1460-4757-95af-ae15fc56ea59

status

definição do status

Campo obrigatório

active

Valor padrão: active

events

Definição dos eventos deverão ser retornados ao endpoint específico.

Campo obrigatório

📘
Requisição para a cri

Ver lista completa de eventos em: Eventos ]

2. Consulta à lista de webhooks

Após o cadastro do Webhook, poderá ser consultado atráves do método GET

GET /api/v2/webhooks?access_token={{access_token}}

{
  "hooks": [
    {
      "endpoint": "https://webhook.site/#!/4e398798-1460-4757-95af-ae15fc56ea59",
      "secret": "df68e1bf3efad0dfb445923e73b98c40",
      "status": "active",
      "events": [
        "add_image",
        "upload"
      ],
      "key": "60160f41-9dc6-481b-9a4f-bfd83add1cb8",
      "created_at": "2021-07-28T10:34:44.849-03:00",
      "updated_at": "2021-07-28T10:34:44.849-03:00"
    }
  ]
}