Sign in

v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

GET Webhooks notifications

Este endpoint permite listar todas as notificações enviadas para os webhooks cadastrados por sua empresa no sistema.

Exemplos de filtros:
?status=200
?type=REQUESTS_UPDATED
?date=2024-10-30

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

É possível filtrar os resultados utilizando os query params disponíveis listados abaixo.

get/api/webhooks/notifications

Query parameters

type'REQUESTS_EMAIL_OPENED' | 'REQUESTS_UPDATED' | 'REQUESTS_CHAIN_UPDATED' | 'REQUESTS_OPENED' | 'FILE_UPLOADED' | 'FILE_DUPLICATED' | 'FILE_GENERATED_WITH_AI' | 'LOTE_REQUEST_EMAIL_OPENED' | 'LOTE_REQUEST_OPENED' | 'LOTE_REQUEST_CHAIN_UPDATED' | 'LOTE_REQUEST_UPDATED'

Tipo do webhook.

statusinteger

Status de atividade do webhook, sendo 1 para ativo e 0 inativo.

datestring

Deve ser uma data válida no formato Y-m-d.

Response

200

current_pageinteger

Número da página atual.

first_page_urlstring

URL da primeira página.

frominteger

Índice do primeiro item da página atual.

last_pageinteger

Número da última página.

last_page_urlstring

URL da última página.

next_page_urlstring

URL da próxima página, ou null se não houver.

pathstring

URL base da paginação.

per_pageinteger

Quantidade de itens por página.

prev_page_urlstring

URL da página anterior, ou null se não houver.

tointeger

Índice do último item da página atual.

totalinteger

Total de notificações cadastradas.

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 1225,
      "url": "https://webhook-empresa.com",
      "data": "{\"document_key\":\"F2d3cdRygtA0dt83dOgA5PWRdj4jB583\",\"signing_key\":\"dk3K15St2X1Q4v3Y3o5iN6y383C2u1cN5\",\"status\":\"Open\",\"data\": {\"file_name\":\"exemplo-doc\",\"date\":\"2023-11-29 14:45:35\"},\"webhook_type\":\"REQUESTS_UPDATED\"}",
      "status": 404,
      "type": "REQUESTS_UPDATED",
      "date_time": "2024-07-01 16:18:22"
    }
  ],
  "first_page_url": "https://app.plugsign.com.br/api/webhooks/notifications?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://app.plugsign.com.br/webhooks/notifications?page=1",
  "links": [
    {
      "label": "« Previous"
    }
  ],
  "path": "https://app.plugsign.com.br/api/webhooks/notifications",
  "per_page": 15,
  "to": 1,
  "total": 1
}