Ver .md

integrations.record

Detalhe de uma requisição. Corpo, cabeçalhos e tentativas de uma requisição de integrations.records. Entrada: o corpo normalizado que o Atomiks guardou (traz dados pessoais do comprador); os cabeçalhos recebidos não são guardados. Saída: o corpo e os cabeçalhos enviados (sem a assinatura), a resposta e o erro da última tentativa.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/integrations.record (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: automations:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: integrations_record
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId integrations.record)

Entrada

CampoTipoObrigatórioNota
integrationIdstring (uuid)sim
idstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "integrationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "integrationId",
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/integrations.record \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"integrationId":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs integrations.record --json '{"integrationId":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta integrations_record com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "in",
        "out"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "COMPLETED",
        "PROCESSING",
        "FAILED",
        "DELAYED"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "trigger": {
      "type": [
        "string",
        "null"
      ]
    },
    "attempts": {
      "type": "number"
    },
    "responseStatus": {
      "type": [
        "number",
        "null"
      ]
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "body": {},
    "headers": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "type",
    "status",
    "createdAt",
    "trigger",
    "attempts",
    "responseStatus",
    "error",
    "body",
    "headers"
  ],
  "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).