Cadastrar webhook

Homologação

https://hml.api.pedagioeletronico.com.br/am-gateway-api/v1

POST

/webhook

Webhooks Config

Cadastra configuração de webhook para recebimento de notificações.

O parceiro deve cadastrar dois webhooks:

TRANSACOES — recebe notificações de novas passagens e atualizações

PEDIDOS — recebe notificações sobre o status dos pedidos de pagamento

Regras:

Apenas um webhook ativo por tipo por parceiro

Para alterar a URL ou chave, remover o webhook existente e cadastrar novamente

A URL deve ser HTTPS com certificado SSL válido

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Webhook cadastrado com sucesso

Body

🟠409

🟠400BadRequest

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

cURL

Webhook de transaçõesWebhook de pedidos

curl --location --request POST 'https://hml.api.pedagioeletronico.com.br/am-gateway-api/v1/webhook' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://parceiro.exemplo.com.br/webhook/transacoes",
    "chaveSecreta": "minha_chave_secreta_hmac_256",
    "tipo": "TRANSACOES"
}'

Response Example

201 - Sucesso

{
    "success": true,
    "data": {
        "url": "https://parceiro.exemplo.com.br/webhook/transacoes",
        "tipo": "TRANSACOES",
        "status": "ATIVO",
        "dataCriacao": "2026-04-01T10:00:00Z",
        "dataInativacao": null
    },
    "meta": {
        "timestamp": "2026-04-01T10:00:00Z",
        "requestId": "req_abc123"
    }
}

Modificado em 2026-04-02 17:47:55

Próxima página

Listar webhooks configurados