Ver .md

integrations.test_url

Enviar teste para uma URL (antes de criar). Envia agora o evento test.ping.v1 para a URL (https) da tela de criação de uma integração de saída, sem criar nada. O envio vai assinado com um segredo descartável; depois de criar, use integrations.test.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/integrations.test_url (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: automations:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: integrations_test_url
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId integrations.test_url)

Entrada

CampoTipoObrigatórioNota
urlstring (uri)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "url"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/integrations.test_url \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://hooks.example.com/atomiks"}'

CLI:

node cli/atomiks.mjs integrations.test_url --json '{"url":"https://hooks.example.com/atomiks"}'

MCP: ferramenta integrations_test_url com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "status": {
      "type": "number"
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).