---
title: "Testar mensagem webhook para assinatura"
method: POST
path: "/api/service/sign/v1/webhook/test/signature"
tags: ["Webhook"]
---

# Testar mensagem webhook para assinatura

`POST /api/service/sign/v1/webhook/test/signature`

## Request

- Base URL: `https://cloud-hom.bry.com.br`
- URL: `https://cloud-hom.bry.com.br/api/service/sign/v1/webhook/test/signature`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/docs/api/service/sign/v1/webhook/test/signature/post.ts> (a function with typed inputs; its response is checked against the schema)

Permite testar o retorno e o recebimento de mensagem que é enviada pelo serviço após conclusão de uma assinatura.

## Request body

- object
  - `url` string: 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.

## Response `200`

Retorno de uma assinatura para webhook

- object
  - `uuid` string: Request_id criado para o envio
  - `signer` WebhookSignerResp: Retorno de um assinante para webhook
    - `signerNonce` string: Valor nonce do assinante, definido pelo usuário ou gerado pelo backend
    - `signerUuid` string: Valor UUID do assinante, gerado pelo backend
    - `name` string: Nome do assinante
    - `signatureStatus` 'PENDING' | 'SIGNED' | 'REFUSED': Status da assinatura deste assinante. PENDING - Assinatura ainda não foi realizada; SIGNED - Assinatura realizada; REFUSED - Assinatura recusada.
  - `documents` WebhookDocumentResp[]
    - `documentNonce` string: Valor nonce do documento, definido pelo usuário ou gerado pelo backend
    - `documentUuid` string: Valor UUID do documento, gerado pelo backend
    - `currentDocumentLink` object: Link de acesso com autenticação ao documento contendo as assinaturas já realizadas
      - `href` string
    - `originalDocumentLink` object: Link de acesso com autenticação ao documento original
      - `href` string

## Other responses

- `4XX`: Retorno de erro da aplicação
- `5XX`: Retorno de erro da aplicação

---

[API](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest.md) - [All operations](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/llms.txt) - [OpenAPI document](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/revisions/c87e026e87ac?raw)