POST Webhook

Changed on Nov 3, 2026

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

Só é possível cadastrar um webhook por tipo em cada empresa; um segundo webhook do mesmo tipo responde 422. A resposta é 201 Created.

post/api/webhooks

Request

Base URL
https://app.plugsign.com.br
URL
https://app.plugsign.com.br/api/webhooks
Auth
API key in header Authorization

Request body

urlstring required

Endereço do seu sistema que receberá as notificações deste webhook. Precisa ser uma URL válida (HTTPS, acessível sem autenticação).

statusboolean

Status de atividade: true/1 ativo, false/0 inativo. Padrão: ativo quando omitido.

Tipo de evento do webhook (um webhook por tipo por empresa).

Response

Webhook criado

Example response

{
  "data": {
    "id": 7,
    "url": "https://webhook.site/4b782c19-e867-4b93-9a2d-7cade71d95a7",
    "type": "REQUESTS_UPDATED",
    "status": 1
  }
}

Changes

Nov 3, 20263db1513040ea Revision changes
- breaking
  removed the enum value FILE_DUPLICATED FILE_GENERATED_WITH_AI of the request property
- breaking
  removed the success response with the status
- info
  the request property default value true was added
- info
  added the new FILE_GENERATED_WITH_AI enum value to the request property
- info
  added the non-success response with the status
- info
  added the success response with the status

Operation history