PLplugsign

GET Webhooks notifications

Changed on

Este endpoint lista as notificações enviadas pelos webhooks da sua empresa, com paginação (15 por página, configurável por per_page).

Exemplos de filtros: ?status=200, ?type=REQUESTS_UPDATED, ?date=2024-10-30, ?document_key=..., ?webhook_id=7.

Os filtros type, document_key e data_status procuram também dentro do payload (data) da notificação. Com webhook_id a resposta usa paginação simples: não traz last_page, last_page_url, total nem links.

get/api/webhooks/notifications

Request

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

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

Código HTTP devolvido pelo seu endpoint ao receber a notificação (ex.: 200, 404, 500). É o mesmo valor de data[].status.

datestring

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

document_keystring

Filtra as notificações pelo document_key contido no payload da notificação.

data_status'Open' | 'Signed' | 'Cancelled' | 'Declined'

Filtra pelo status do documento contido no payload (Open, Signed, Cancelled, Declined). A busca é textual no payload.

webhook_idinteger

Filtra pelas notificações de um webhook específico. Um webhook de outra empresa responde 404. Com este filtro a resposta usa paginação simples (sem last_page, total e links).

per_pageinteger

Itens por página, de 1 a 100. Padrão: 15.

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
}

Changes

  • 3db1513040eaRevision changes
    • info

      added the new optional query request parameter data_status

    • info

      added the new optional query request parameter document_key

    • info

      added the new optional query request parameter per_page

    • info

      added the new optional query request parameter webhook_id

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status