Axuz Developers

POST /teams/{teamId}/integrations/

Cria a integracao

  • Acesso: Membro da equipe
  • Serviço: https://api.axuz.net

Autenticação aceita

  • 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`.

Owner/admin do time. Nome unico por time (case-insensitive). metadata e NAO-secreta (chave com cara de segredo e recusada).

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
providerstringsim

enum: "custom_bot", "github", "slack", "discord", "telegram", "whatsapp", "webhook"

namestringsim
scopesarray<string>sim
metadataobjectnão
{
  "provider": "custom_bot",
  "name": "string",
  "scopes": [
    "tasks:read"
  ],
  "metadata": {}
}

Respostas

201

Criada

NomeTipoObrigatórioDescrição
idstring<uuid>sim
team_idstring<uuid>sim
providerstringsim

enum: "custom_bot", "github", "slack", "discord", "telegram", "whatsapp", "webhook"

namestringsim
statestringsim

enum: "active", "paused", "revoked"

scopesarray<string>sim
metadataobjectsim

NAO-secreta; <= 4 KiB.

created_bystring<uuid>não
created_atstring<date-time>sim
updated_atstring<date-time>sim
revoked_atstring<date-time>não

400

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

NomeTipoObrigatórioDescrição
errorstringsim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

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

NomeTipoObrigatórioDescrição
errorstringsim

409

duplicate | conflict | integration_revoked

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

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

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://api.axuz.net/teams/TEAM_ID/integrations/' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"provider":"custom_bot","name":"string","scopes":["tasks:read"],"metadata":{}}'

Node.js

const res = await fetch("https://api.axuz.net/teams/TEAM_ID/integrations/", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "provider": "custom_bot",
    "name": "string",
    "scopes": [
      "tasks:read"
    ],
    "metadata": {}
  }),
});
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/",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "provider": "custom_bot",
        "name": "string",
        "scopes": [
            "tasks:read",
        ],
        "metadata": {},
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())