Sign in

v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Webhook

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

post/api/webhooks

Request body

urlstring required

O endereço do seu sistema para o qual este webhook deve enviar os dados de resposta. Must be a valid URL.

statusboolean

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

Example response

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