Axuz Developers

POST /integrations/inbound/{webhookId}

Webhook de ENTRADA (o bot/servico externo chama o Axuz)

  • Access: Public
  • Service: https://api.axuz.net

Accepted authentication

  • hmacSignature — t=<unix>,v1=<hmac-sha256-hex>

Sem sessao: a credencial e a assinatura HMAC com o segredo do webhook in. Ordem fail-closed: rate limit por IP de origem + webhook (120/min) e teto por webhook (1200/min) -> 429; contadores em memoria, POR REPLICA (o teto real e o proxy) -> corpo <= 256 KiB (413) -> headers (400) -> webhook inexistente/inativo/ integracao pausada ou revogada (404 uniforme) -> assinatura/janela de 300s (401) -> idempotencia por X-Axuz-Delivery-Id (replay = 409). Aceito = 202 e a chamada fica registrada (hash do corpo, sem o corpo). A v1 NAO executa acao a partir do corpo.

Parameters

NameInTypeRequiredDescription
webhookIdpathstringyes
X-Axuz-Signatureheaderstringyes
X-Axuz-Delivery-Idheaderstringyes
X-Axuz-Eventheaderstringno

Request body

application/json · Required

NameTypeRequiredDescription
(corpo)objectno
{}

Responses

202

Recebido

NameTypeRequiredDescription
statusstringyes

enum: "received"

delivery_idstringyes

400

Corpo/parametro invalido (invalid, invalid_body, invalid_cursor...)

NameTypeRequiredDescription
errorstringyes

401

invalid_signature | signature_expired

NameTypeRequiredDescription
errorstringyes

404

Nao existe NESTE time (404 uniforme: nao vaza existencia entre times)

NameTypeRequiredDescription
errorstringyes

409

replayed_delivery

NameTypeRequiredDescription
errorstringyes

413

payload_too_large

NameTypeRequiredDescription
errorstringyes

429

rate_limited

NameTypeRequiredDescription
errorstringyes

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NameTypeRequiredDescription
errorstringyes

503

secret_unavailable (nunca aceita sem verificar)

NameTypeRequiredDescription
errorstringyes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

curl

curl -sS -X POST 'https://api.axuz.net/integrations/inbound/WEBHOOK_ID' \
  -H "Cookie: access_token=$AXUZ_SESSION_JWT" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch("https://api.axuz.net/integrations/inbound/WEBHOOK_ID", {
  method: 'POST',
  headers: {
    Cookie: `access_token=${process.env.AXUZ_SESSION_JWT}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api.axuz.net/integrations/inbound/WEBHOOK_ID",
    headers={
        "Cookie": f"access_token={os.environ['AXUZ_SESSION_JWT']}",
    },
    json={},
    timeout=30,
)
res.raise_for_status()
print(res.json())