GET Webhooks notifications

get

https://app.plugsign.com.br/api/webhooks/notifications

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

enum

Tipo do webhook.

status

int32

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

date

string

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

document_key

string

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

data_status

string

enum

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

Allowed:

webhook_id

integer

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_page

integer

1 to 100

Defaults to 15

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404webhook_id inexistente ou de outra empresa

422Erro de validação