Criar webhook

Sandbox

https://api.sandbox.supersign.com.br

POST

/v4/api/webhooks/

Cadastra um destino HTTPS para receber eventos da conta.

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Criado

Headers

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠409

🟠422Erro de Parâmetro

🟠429

🔴503Serviço Indisponível

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.sandbox.supersign.com.br/v4/api/webhooks/' \
--header 'Idempotency-Key: 7d3f1c52-9a4b-4e6d-8f20-5b1c9e3a7d41' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://sistema.exemplo.com.br/webhooks/supersign",
    "events": [
        "ENVELOPE_COMPLETED",
        "SIGNATORY_SIGNED",
        "PARTICIPANT_DECLINED"
    ],
    "isActive": true
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "url": "string",
    "events": [
        "ENVELOPE_COMPLETED"
    ],
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "signingSecret": "string"
}

Modificado em 2026-10-10 22:15:13