---
title: "POST Webhook"
method: POST
path: "/api/webhooks"
---

# POST Webhook

`POST /api/webhooks`

Este endpoint permite que você **cadastre um novo webhook** para receber notificações automáticas sobre eventos específicos da plataforma.

**Tipos disponíveis:** `REQUESTS_EMAIL_OPENED`, `REQUESTS_UPDATED`, `REQUESTS_CHAIN_UPDATED`, `REQUESTS_OPENED`, `LOTE_REQUEST_UPDATED`, `LOTE_REQUEST_CHAIN_UPDATED`, `LOTE_REQUEST_OPENED`, `LOTE_REQUEST_EMAIL_OPENED`, `FILE_UPLOADED`, `FILE_DUPLICATED`, `FILE_GENERATED_WITH_AI`

## Request body

- object
  - `url` string, required — O endereço do seu sistema para o qual este webhook deve enviar os dados de resposta. Must be a valid URL.
  - `status` boolean — Status de atividade do webhook, sendo 1 para ativo e 0 inativo.
  - `type` 'REQUESTS_EMAIL_OPENED' | 'REQUESTS_UPDATED' | 'REQUESTS_CHAIN_UPDATED' | 'REQUESTS_OPENED' | 'FILE_UPLOADED' | 'FILE_DUPLICATED' | 'FILE_DUPLICATED FILE_GENERATED_WITH_AI' | 'LOTE_REQUEST_UPDATED' | 'LOTE_REQUEST_CHAIN_UPDATED' | 'LOTE_REQUEST_OPENED' | 'LOTE_REQUEST_EMAIL_OPENED', required — O tipo de webhook que será criado.

## Response `200`

200

- object
  - `data` object — Objeto principal contendo os dados do webhook criado.
    - `id` integer — Identificador único do webhook.
    - `url` string — URL de destino para onde as notificações do webhook serão enviadas.
    - `type` 'REQUESTS_EMAIL_OPENED' | 'REQUESTS_UPDATED' | 'REQUESTS_CHAIN_UPDATED' | 'REQUESTS_OPENED' | 'FILE_UPLOADED' | 'FILE_DUPLICATED' | 'FILE_GENERATED_WITH_AI' | 'LOTE_REQUEST_UPDATED' | 'LOTE_REQUEST_CHAIN_UPDATED' | 'LOTE_REQUEST_OPENED' | 'LOTE_REQUEST_EMAIL_OPENED' — Tipo do evento que dispara o webhook.
    - `status` integer — Status de atividade do webhook. 1 = ativo, 0 = inativo.

---

[API](https://skmtc.net/plugsign/apis/endpoints-manuais.md) · [All operations](https://skmtc.net/plugsign/apis/endpoints-manuais/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plugsign/endpoints-manuais/revisions/41e10c7c691b/schema)