Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Webhook

Testar mensagem webhook para envio

Permite testar o retorno e o recebimento de mensagem que é enviada pelo serviço após alteração no estado do envelope.

post/api/service/sign/v1/webhook/test/collection

Request body

urlstring

Url para a qual o payload de exemplo será enviado. Caso vazio, método apenas irá retornar o valor de exemplo como resposta da requisição.

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

Método que será utilizado para enviar o payload de exemplo.

Example request

{
  "url": "http://minhaaplicacao.com.br:5670/receber/mensagem/webhook",
  "method": "POST"
}

Response

Retorno de um envio para webhook

uuidstring

Request_id criado para o envio

namestring

Nome atribuído ao envio e exibido para o assinante

status'DRAFT' | 'CREATED' | 'ONGOING' | 'FINISHED' | 'EXPIRED' | 'DELETED'

Status atual deste envio. CREATED - Envio de assinatura foi gerado; ONGOING - Assinaturas do envio foram inicializadas; FINISHED - Todas as assinaturas definidas no envio foram realizadas; EXPIRED - Tempo de expiração do envio chegou ao fim sem que todas as assinaturas tenham sido realizadas; DELETED - Envio foi deletado sem que todas as assinaturas tenham sido realizadas; DRAFT - Envelope está em estado de rascunho, signatários ainda não podem realizar assinaturas;

expirationstring

Unix timestamp de expiração do envio

Example response

{
  "uuid": "a0089a7c-3f15-48d2-995a-6f59ed79f824",
  "name": "Envio de assinaturas Bry Tecnologia",
  "status": "CREATED",
  "expiration": "1698912385",
  "signers": [
    {
      "signerNonce": "Signer Nonce",
      "signerUuid": "d23ef88b-d749-49c4-a8ac-58ca397a9927",
      "name": "João Qualificada",
      "signatureStatus": "Pending"
    }
  ],
  "documents": [
    {
      "documentNonce": "DocumentNonce",
      "documentUuid": "d23ef88b-d749-49c4-a8ac-58ca397a9927",
      "currentDocumentLink": {
        "href": "https://easysign.bry.com.br/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}/signed"
      },
      "originalDocumentLink": {
        "href": "https://easysign.bry.com.br/api/service/sign/v1/signatures/{request_id}/documents/{documentNonce}/file"
      }
    }
  ]
}