Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Webhook

Cadastrar vínculo Webhook

Permite adicionar um vínculo de mensagem de atualização (serviço de webhook) para atualizações no estado do envelope (easy.collection) ou para atualizações no estado de qualquer assinatura de um envelope (easy.signature) para o usuário autenticado. Após o vínculo, quando houver a atualização do envelope ou da assinatura, uma mensagem com todos os dados relevantes para aquela atualização é enviada para o endpoint da aplicação cliente configurado por meio desta chamada.

post/api/service/sign/v1/webhook

Request body

webhookType'easy.collection' | 'easy.signature'

Tipo de vínculo Webhook. easy.collection - Para atualizações no estado do envelope; easy.signature - para atualizações no estado de qualquer assinatura de um envelope.

urlEndpointstring

Nome do assinante dentro do envio a ser gerado.

Example request

{
  "webhookType": "easy.signature",
  "urlEndpoint": "http://minhaaplicacao.com.br:5670/receber/mensagem/webhook"
}

Response

Retorno de Sucesso para detalhes da criação de um vínculo Webhook

webhookIdstring

UUID do vínculo Webhook gerado.

methodIdstring

UUID do método Webhook gerado.

descriptionstring

Descrição do vínculo Webhook.

urlEndpointstring

Endpoint configurado para disparo da mensagem de atualização do Webhook.

authTypestring

Tipo de autenticação escolhida para o endpoint configurado. No momento suporta apenas NONE

authKeystring

Chave de autenticação, quando authType for diferente de NONE.

webhookTypestring

Tipo de vínculo Webhook. Para atualizações no estado do envelope (easy.collection) ou para atualizações no estado de qualquer assinatura de um envio (easy.signature) para o usuário autenticado. Valores disponíveis: [easy.collection, easy.signature]

usernamestring

Nome de usuário no Portal Bry, coletado por meio do token JWT e usado para enfileiramento das mensagens de Webhook.

Example response

[
  {
    "webhookId": "c98f2e6d-9bab-489f-be4a-bfbcf55ad7b5",
    "methodId": "18889292-255d-4ab9-9f23-9615a7e124b0",
    "description": "Webhook que vai ser chamado quando houver uma alteração de estado da assinatura.",
    "urlEndpoint": "http://minhaaplicacao.com.br:5670/receber/mensagem/webhook",
    "authType": "NONE",
    "webhookType": "easy.signature",
    "username": "bry.tecnologia"
  }
]