Ver .md

integrations.events

Eventos recebidos. Últimos 100 eventos recebidos por uma integração de entrada, sem o corpo (use integrations.get_event). before pagina por data de recebimento.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/integrations.events (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_events
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId integrations.events)

Entrada

CampoTipoObrigatórioNota
integrationIdstring (uuid)sim
beforestringnãoCursor: nextBefore da página anterior (data ISO).
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)$"
    },
    "before": {
      "description": "Cursor: `nextBefore` da página anterior (data ISO).",
      "type": "string"
    }
  },
  "required": [
    "integrationId"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta integrations_events com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "rawEvent": {
            "type": [
              "string",
              "null"
            ]
          },
          "eventName": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "processed",
              "ignored",
              "failed"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          },
          "receivedAt": {
            "type": "string"
          },
          "processedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "contactId": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "rawEvent",
          "eventName",
          "status",
          "error",
          "receivedAt",
          "processedAt",
          "contactId"
        ],
        "additionalProperties": false
      }
    },
    "nextBefore": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "items",
    "nextBefore"
  ],
  "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).