Exemplo de Doc de Eventos

Os eventos relacionados à Gestão de livros disparam mensagens sempre que há atualizações sobre o cadastro e descadastro de um livro e sobre alterações nas informações de livros registrados.

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

• Configurar previamente o recebedor de eventos do webhook.
• Conhecer a estrutura básica dos eventos que acompanha o objeto data.

Informações sobre os eventos

Contexto e nome(s) do(s) evento(s)

Os campos context e name poderão variar de acordo com a tabela a seguir:

Identificador (entityId)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de Gestão de livros, o entityId é o identificador único do livro (bookId).

Dados dos eventos

BOOK_WAS_REGISTERED

Esse evento sinaliza que um livro foi inserido no catálogo de uma editora.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

{ 
   "entityId": "21685648", 
   "companyKey": "ACESSO", 
   "idempotencyKey": "b4b9812d-b5ce-4577-a223-b0dff8850f0f", 
   "context": "Book", 
   "name": "BOOK_WAS_REGISTERED", 
   "version": "1.0", 
   "timestamp": "2022-11-11T20:04:27.7976728Z", 
   "correlationId": "a9f174c0-2a95-473c-935a-cc26fded2720", 
   "data": {  
    "title": "O mistério do código quebrado",
    "author": "Silvana Sales",
    "isbn": "9786589999013",
    "genre": "horror"  
   } 
} 

BOOK_WAS_UPDATED

Este evento sinaliza que...