Create

POST

/api/user/webhook

Este endpoint permite ao usuário registrar um novo webhook, informando a URL de destino e o tipo de evento que deseja escutar.

✅ Requisitos da Requisição

Método HTTP: POST

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 obrigatórios

No corpo da requisição (body):

{
  "url": "https://meusite.com/webhook-endpoint",
  "type": "evento.exemplo"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/user/webhook' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://webhook.com",
    "type": "INFRACTION"
}'

Response Example

201 - Success

{
    "status": 201,
    "message": "Webhook criado com sucesso",
    "data": {
        "id": "0000000-0000-0000-0000000000000",
        "gatewayId": "0000000-0000-0000-0000000000000",
        "sellerId": "0000000-0000-0000-0000000000000",
        "url": "http://webhook.com",
        "type": "INFRACTION",
        "createdAt": "2025-04-15T19:13:29.179Z",
        "updatedAt": "2025-04-15T19:13:29.179Z"
    },
    "error": null
}

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

⚙️ Webhook: Formato de Postback

Find all

Create

✅ Requisitos da Requisição#

🧠 Header da requisição#

📥 Parâmetros obrigatórios#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

📥 Parâmetros obrigatórios