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

# Testar mensagem webhook para envio

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

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

## 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 um envio para webhook

- object
  - `uuid` string — Request_id criado para o envio
  - `name` string — 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;
  - `expiration` string — Unix timestamp de expiração do envio
  - `signers` WebhookSignerResp[]
    - `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.net/bry/apis/bry-easy-sign-api-rest.md) · [All operations](https://skmtc.net/bry/apis/bry-easy-sign-api-rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bry/bry-easy-sign-api-rest/versions/c87e026e87ac/schema)