Ver .md

message_history.webhook_detail

Detalhe de uma entrega de webhook. Uma entrega de message_history.webhooks com o corpo enviado (payload, montado do evento de origem; traz dados pessoais do contato), as tentativas e o envio.

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

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/message_history.webhook_detail \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

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

MCP: ferramenta message_history_webhook_detail 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"
    },
    "provider": {
      "type": "string"
    },
    "event": {
      "type": "string"
    },
    "httpStatus": {
      "type": [
        "number",
        "null"
      ]
    },
    "newStatus": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "queued",
            "sending",
            "sent",
            "delivered",
            "failed",
            "visualized"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "externalMessageId": {
      "type": [
        "string",
        "null"
      ]
    },
    "messageInstanceId": {
      "type": "null"
    },
    "processingError": {
      "type": [
        "string",
        "null"
      ]
    },
    "receivedAt": {
      "type": "string"
    },
    "attempts": {
      "type": "number"
    },
    "sentAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "payload": {}
  },
  "required": [
    "id",
    "provider",
    "event",
    "httpStatus",
    "newStatus",
    "externalMessageId",
    "messageInstanceId",
    "processingError",
    "receivedAt",
    "attempts",
    "sentAt",
    "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).