Partner

Os eventos relacionados ao Partner disparam mensagens sempre que houver indisponibilidade em um ou mais serviços de uma feature, seja por motivo de manutenção, seja por algum problema interno em nosso sistema.

Quando o serviço retornar à normalidade, o parceiro também receberá uma mensagem.

🚧

Importante

As requisições realizadas durante o período de indisponibilidade não ficarão retidas. Ou seja, será necessário realizar uma nova requisição assim que o serviço retornar à normalidade.

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)

O contexto (context) e o nome do evento (name) poderão variar de acordo com a tabela a seguir:

Fluxo dos eventos

O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:

Identificador (entityId)

No contexto de Partner, o entityId é o nome (name) da feature.

Dados dos eventos

FEATURE_WAS_ENABLED

Este evento sinaliza que uma feature foi habilitada.

Descrição do objeto data do evento

Payload do evento

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

{
        "entityId": "bill_payment",
        "companyKey": "FLORESTA_ED",
        "idempotencyKey": "f58d7877-53c3-4f09-a1d6-343338670929",
        "context": "Partner",
        "timestamp": "2023-08-16T20:22:10.5429817Z",
        "correlationId": "f310e8a9-5097-4f68-8748-bc699d0d9efe",
        "name": "FEATURE_WAS_ENABLED",
        "data": {
            "name": "bill_payment",
            "updatedAt": "2023-08-16T20:22:01.9472626Z"
        }
 }

FEATURE_WAS_DISABLED

Este evento sinaliza que uma feature foi desabilitada.

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": "bill_payment",
        "companyKey": "FLORESTA_ED",
        "idempotencyKey": "c49ab169-05f4-4d30-af6a-cce785128fa3",
        "context": "Partner",
        "timestamp": "2023-08-16T20:36:24.5074824Z",
        "correlationId": "01309768-2d18-4769-8583-575aa9222058",
        "name": "FEATURE_WAS_DISABLED",
        "data": {
            "name": "bill_payment",
            "reason": "Indisponibility",
            "updatedAt": "2023-08-16T20:36:24.1013232Z"
        }
 }