Axuz Developers

POST /teams/{teamId}/integrations/{id}/webhooks

Cria webhook de saida (out) ou segredo de entrada (in)

  • Access: Team member
  • Service: https://api.axuz.net

Accepted authentication

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

out: url https + events obrigatorios (SSRF validado no cadastro e de novo no envio). in: sem url/events; o segredo e o que o bot usa para ASSINAR as chamadas a POST /integrations/inbound/{webhookId}. Max 10 por integracao (422 limit_exceeded). Segredo mostrado UMA vez.

Parameters

NameInTypeRequiredDescription
teamIdpathstringyes
idpathstringyes

Request body

application/json · Required

NameTypeRequiredDescription
directionstringyes

enum: "out", "in"

urlstring<uri>no
eventsarray<string>no
channel_idsarray<string<uuid>>no

Canais privados/DM do time que o webhook pode receber. So direction=out.

{
  "direction": "out",
  "url": "https://example.test/",
  "events": [
    "task.created"
  ],
  "channel_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

201

Criado

NameTypeRequiredDescription
idstring<uuid>yes
integration_idstring<uuid>yes
directionstringyes

enum: "out", "in"

urlstring<uri>no

So direction=out; https.

eventsarray<string>yes
channel_idsarray<string<uuid>>no

Canais privados/DM autorizados (default vazio = so publicos).

activebooleanyes
secret_versionintegeryes
created_atstring<date-time>yes
updated_atstring<date-time>yes
secret_rotated_atstring<date-time>no
secretstringyes

whsec_*. MOSTRADO UMA VEZ; guardado cifrado.

400

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

NameTypeRequiredDescription
errorstringyes

401

Sem credencial valida

NameTypeRequiredDescription
errorstringyes

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NameTypeRequiredDescription
errorstringyes

404

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

NameTypeRequiredDescription
errorstringyes

422

Limite de webhooks

NameTypeRequiredDescription
errorstringyes

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

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

NameTypeRequiredDescription
errorstringyes

503

Sem chave mestra (segredo nunca em claro) — secret_encryption_unavailable

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/teams/TEAM_ID/integrations/ID/webhooks' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"direction":"out","url":"https://example.test/","events":["task.created"],"channel_ids":["00000000-0000-0000-0000-000000000000"]}'

Node.js

const res = await fetch("https://api.axuz.net/teams/TEAM_ID/integrations/ID/webhooks", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "direction": "out",
    "url": "https://example.test/",
    "events": [
      "task.created"
    ],
    "channel_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }),
});
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/teams/TEAM_ID/integrations/ID/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "direction": "out",
        "url": "https://example.test/",
        "events": [
            "task.created",
        ],
        "channel_ids": [
            "00000000-0000-0000-0000-000000000000",
        ],
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())