Listar eventos de webhook

🔽
GET urlServidor/v1/marketplace/hooks/hook-events

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/hooks/hook-eventss' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Nome	Local	Tipo	Obrigatório	Descrição
filters	Query	String	Opcional	Filtros em formato JSON. Exemplo: `{ "status": "CREATED" }`
search	Query	String	Opcional	Texto de busca. Campos pesquisáveis: `name`, `description`.
perPage	Query	Number	Opcional	Limitado ao máximo de 100 por página.
page	Query	Number	Opcional	Número da página.
sorters	Query	String	Opcional	JSON com lista de ordenadores. Campos: `id`, `created_at`. Exemplo: `[ { "column": "created_at", "direction": "DESC" } ]`

Exemplo de Response de sucesso.

{
  "total":1,
  "page": 1,
  "perPage": 20,
  "lastPage": 1,
  "data": [
     {
            "id": 5,
            "name": "new-sub-transaction",
            "description": "Nova transação Sub.",
            "active": true,
            "url": "https://meusistema.com.br/webhook-receiver",
            "basic_user": null,
            "basic_pass": null,
            "created_at": "2025-09-15T20:01:46.000Z",
            "updated_at": "2025-09-15T20:01:46.000Z"
        }
  ]
}

📤Explicação do resposta

Campo	Tipo	Descrição
total	Number	Número total de registros encontrados conforme os filtros aplicados.
page	Number	Página atual retornada.
perPage	Number	Quantidade de registros retornados por página.
lastPage	Number	Número total de páginas considerando a paginação aplicada.
data	Array	Lista de eventos de webhook retornados.
id	Number	Identificador único do evento webhook.
active	Boolean	Indica se o evento webhook está ativo (`true`) ou inativo (`false`).
name	String	Nome descritivo do evento webhook.
url	String	URL configurada para recebimento do payload do webhook.
basic_user	String	Usuário utilizado para autenticação básica (HTTP Basic Auth) na URL de destino, se configurado.
basic_pass	String	Senha utilizada para autenticação básica na URL de destino, se configurado.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.