API Reference
  1. PlugSign Documentation
  2. Webhooks

POST Webhook

post
https://app.plugsign.com.br/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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
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).

boolean
Defaults to true

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

string
enum
required

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

Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?