---
title: "Testar webhook"
method: POST
path: "/v1/webhooks/{webhookId}/test"
tags: ["Webhooks"]
---

# Testar webhook

`POST /v1/webhooks/{webhookId}/test`

## Request

- Base URL: `https://api.signdocs.com.br`
- URL: `https://api.signdocs.com.br/v1/webhooks/{webhookId}/test`
- Auth: HTTP bearer

Envia um payload de teste para o endpoint do webhook e retorna o resultado da entrega.
Útil para verificar conectividade e configuração do webhook.

Requer scope `webhooks:write`.

## Path parameters

- `webhookId` string, required

## Response `200`

Resultado do teste de entrega.

- WebhookTestResponse: Resposta de teste de webhook.
  - `webhookId` string, required
  - `testDelivery` object, required
    - `httpStatus` integer, required: Código HTTP retornado pelo endpoint.
    - `success` boolean, required: Se a entrega de teste foi bem-sucedida.
    - `error` string: Mensagem de erro (se a entrega falhou).
    - `timestamp` string, date-time, required: Momento da tentativa de entrega.

## Other responses

- `401`: Autenticação ausente ou inválida.
- `403`: Permissões insuficientes para a operação solicitada. Inclui `purpose: "ACTION_AUTHENTICATION"` sem `featureFlags.trustSessionsEnabled`. A verificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`. O remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.
- `404`: Recurso não encontrado.
- `500`: Erro interno do servidor.

---

[API](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api.md) · [All operations](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/revisions/2d3805aed161?raw)