Find all

GET

/api/user/webhook

Este endpoint permite consultar os webhooks cadastrados pelo usuário autenticado, com suporte a filtros de busca, paginação e ordenação.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/webhook

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

⚙️ Parâmetros opcionais (query params)

Parâmetro	Tipo	Descrição
`limit`	inteiro	Quantidade de registros por página
`page`	inteiro	Página atual a ser consultada
`value`	string	Texto a ser buscado (aplica filtro nos campos relevantes)
`orderDirection`	string	Direção da ordenação (`asc` ou `desc`)
`orderBy`	string	Campo utilizado para ordenação (`id`, `type`, `created_at`, etc)

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/webhook?limit=10&page=1&value=1000&orderDirection=desc&orderBy=id' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
    "status": 200,
    "message": "Webhooks listados com sucesso",
    "data": {
        "data": [
            {
                "id": "00000-000b-4000-0000-0000000000",
                "url": "https://teste.com/webhook",
                "type": "TRANSACTION",
                "createdAt": "2025-04-08T17:10:31.700Z",
                "updatedAt": "2025-04-08T17:10:42.084Z"
            }
        ],
        "pages": 1,
        "page": 1,
        "limit": 10,
        "total": 1
    },
    "error": null
}

Modified at 2025-07-23 19:02:40

Create

Find by ID

Find all

✅ Requisitos da Requisição#

🧠 Header da requisição#

⚙️ Parâmetros opcionais (query params)#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

⚙️ Parâmetros opcionais (query params)