Ver .md

integrations.get_event

Ver um evento recebido. Evento recebido com o corpo normalizado (payload), que traz dados pessoais do comprador.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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": [
    "id"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta integrations_get_event 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"
    },
    "integrationId": {
      "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"
      ]
    },
    "payload": {}
  },
  "required": [
    "id",
    "integrationId",
    "rawEvent",
    "eventName",
    "status",
    "error",
    "receivedAt",
    "processedAt",
    "contactId",
    "payload"
  ],
  "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).