Objeto do evento

Um event registra uma mudança em um objeto público. Seu conteúdo representa o estado no momento daquela mudança; uma entrega posterior preserva o mesmo fato. Um evento pode ser entregue a vários destinos, com tentativas independentes.

Payload completo

{
  "id": "evt_1234567890abcdef",
  "created_at": "2030-01-01T00:00:00.000Z",
  "data": {
    "object": {
      "id": "pro_1234567890abcdef",
      "benefit": null,
      "cover_url": null,
      "created_at": "2030-01-01T00:00:00.000Z",
      "description": null,
      "metadata": {},
      "name": "Curso de exemplo",
      "object": "product",
      "prices": [
        "prc_1234567890abcdef"
      ],
      "status": "draft",
      "updated_at": "2030-01-01T00:00:00.000Z"
    },
    "previous_attributes": {}
  },
  "object": "event",
  "request": {
    "id": "req_example"
  },
  "type": "product.created"
}

Campos

string

Identificador estável com prefixo evt_. Use-o para deduplicar; também aparece no cabeçalho Hubfy-Event-Id.

string

Instante do evento em ISO 8601 com fuso horário. Não é o instante de cada tentativa de entrega.

object

Show Campos de data

object

Objeto público completo correspondente ao tipo, incluindo seus campos nulos e coleções vazias. Em exclusões, conserva o estado anterior e acrescenta deleted: true.

object

Somente os valores anteriores dos campos alterados. Na criação e exclusão, retorna {}. Não é uma cópia inteira do estado anterior.

string

Sempre event.

object

Show Campos de request

string | null

Identificador da requisição que originou a alteração, quando disponível. Pode ser null para alterações sem uma requisição identificada.

string

Nome do evento, como asset.updated. Veja Tipos de eventos.

Relacionamentos

data.object.id identifica o recurso alterado. Seu campo object indica o formato: product, price, asset ou order. Clientes não são uma variante deste catálogo de eventos. Uma entrega é uma tentativa de transportar o evento ao destino. O payload não inclui segredos de assinatura ou dados internos de transporte. A configuração dos destinos e a consulta do histórico ficam no painel do proprietário.

Leitura e atualização

O evento recebido não é editável. Se precisar do estado atual, consulte o objeto pela API. Para objetos excluídos, use os dados conservados no evento; a consulta normal pode retornar 404. Confira entrega e assinatura para lidar com duplicatas e tentativas.

Fundamentos da API

Objetos

Webhooks e eventos

Objeto do evento

Payload completo

Campos

Relacionamentos

Leitura e atualização

​Payload completo

​Campos

​Relacionamentos

​Leitura e atualização

Payload completo

Campos

Relacionamentos

Leitura e atualização