/
16. Configurando eventos de notificação no Diretório

16. Configurando eventos de notificação no Diretório

Owned by Renan Amorim Costa (Unlicensed)
Last updated: 16/04/2025 by Marcos Santana
5 min read

Aqui apresentamos a configuração de webhook no Diretório

Introdução

Webhooks

Habilite notificações em tempo real e orientadas por eventos para manter sua organização alerta sobre todas as mudanças no ecossistema. Permaneça sincronizado e informado sobre atualizações importantes, tais como mudanças para as organizações, APIs, certificados e roles sem a necessidade de constantemente buscar informações.

Webhooks provêm às organizações atualizações em tempo real sobre mudanças no ecossistema, garantindo que elas estejam informadas e atentas.

Através da automação de notificações, webhooks eliminam a necessidade de monitoramento manual, melhorando eficiência operacional significativamente. Adicionalmente, elas oferecem flexibilidade na integração, permitindo que organizações adaptem seus sistemas de maneira dinâmica às atualizações do ecossistema e mantendo interação transparente com outros participantes.

Você pode inscrever uma aplicação ou um authorization server para notificações na Raidiam.

Para aprender como fazer a inscrição para eventos no seu ecossistema, veja o trecho de Inscrição para eventos mais abaixo.

Lista de Eventos que Iniciam um Webhook

Determinadas ações podem resultar em múltiplas notificações sendo enviadas pelo webhook.

Por exemplo, suspender uma aplicação não suspende apenas a aplicação, como também desabilita qualquer certificado ou token de acesso para isso. Consequentemente, notificações separadas são enviadas para cada um desses eventos, com detalhes sobre a desabilitação de cada certificado e token de acesso individualmente.

Criação, atualização ou exclusão

·      Organizações: Notificações são acionadas quando uma organização é criada, atualizada ou deletada do diretório. Isso garante que qualquer mudança em detalhes da organização, como nomes, informação de contatos ou status, são imediatamente notificados à sistemas relevantes.

·       Authorization Server: Mudanças nas configurações de Authorization Server de uma organização – tais como adicionar ou remover uma instância – são comunicadas pelos webhooks.

·       Reivindicações de domínio de autoridade: Notificações são enviadas quando as reivindicações de domínio de uma organização são alteradas.

·       Reinvidicação de papel de domínio de autoridade da organização: Quando uma organização requere ou atualiza sua autorização papel dentro de um domínio, webhooks notificam às partes interessadas.

·       Certificado de Authorization Server: Webhooks são acionados quando o servidor do Authorization Server de uma organização perde ou ganha um certificado. Esses certificados averiguam conformidade com os padrões do ecossistema.

·       API Recursos: Mudanças na API recursos, tais como endpoints, versionamentos ou operações com suporte, acionarão notificações.

·       Endpoint da API Comum (Discovery): Webhooks notificam mudanças relativas a endpoints usados na API Comum (Discovery).

·       Contatos: Notificações são enviadas quando os detalhes no contato da organização, tais como contatos administrativos ou técnicos, são adicionados, atualizados ou removidos.

Criação ou atualização

·       Reivindicação de autoridade de software: Webhooks notificam quando uma reivindicação de autoridade de software é criada ou atualizada.

Criação ou exclusão

·       Autorização por papel de domínio: Notificação são acionadas quando uma autorização por papel dentro de um domínio é tanto concedida quanto revogada por uma autorização.

Criação ou revogação

·       Certificado de Software Statement/Aplicação ou Organização: Webhooks notificação o erro em issue ou revogação de certificados digitais para organizações ou seus softwares. Esses certificados são cruciais para assegurar comunicações e autenticações dentro do ecossistema.

Criação, atualização, deleção, suspensão, reativação/fim da suspensão, bloqueio e desbloqueio

·       Aplicação (Software Statement): Um amplo grupo eventos em webhook são acionados para software statements. Isso inclui criação, atualização, deleção, suspensão, reativação, bloqueio ou desbloqueio.

Outro

  • Termos e condições da organização: Webhooks são acionados quando o processo de assinatura de termos e condições se inicia. Notificações também são enviadas se houverem mudanças no status do processo, tais como aprovação, rejeição ou cancelamento.

Payload de Notifiçações

Os payloads de webhooks são construídos sendo guiados por uma estrutura de “geral-para-específico”. Para cada evento iniciado, a estrutura inteira do recurso alterado é detalhada dentro do payload da resposta.

Esse desenho permite que a cadeia de contexto seja inclusa no payload, permitindo facilidade para interpretação e ação nas notificações.

O evento payload sempre consiste em quatro campos:

·       ApiResource – o identificador do recurso para cada evento ocorrido.

·       UpdateTimestamp – o tempo de cada evento.

·       ResourcePayload – o payload (detalhes) do recurso para qual o evento ocorreu.

·        Revision – um mecanismo de versionamento que acompanha mudanças ou atualizações para o recurso que está sendo notificado.

Para os exemplos mais atualizados de recursos de payload, consulte sempre a documentação da API Raidiam e o esquema para o recurso específico.

Inscrição em eventos

Inscrever uma Authorization Server ou API para eventos acontecendo dentro do ecossistema ou federação inteira.

Inscrevendo Authorization Server em eventos

  1. Acesse a sua organização.

  1. Selecione Servers e selecione um servidor de sua escolha.

  1. Selecione Edit Server.

  1. Inclua no campo Notification Webhook Endpoint o URL para qual a Raidiam enviará as notificações.

  1. Salve.

Inscrevendo aplicações em eventos

  1. Acesse a sua organização.

  1. Selecione Applications e selecione um servidor de sua escolha.

  1. Selecione Edit Application.

  1. Inclua no campo Notification Webhook Endpoint o URL para qual a Raidiam enviará as notificações.

  1. Salve.

Etapa 1: Inscrever-se em um Tópico

Requisitos

1. Em seu navegador, navegue até webhook.site e uma URL única e aleatória será gerada automaticamente. Ela poderá ser utilizada para testar e depurar Webhooks e solicitações HTTP.

 

2. Selecione a URL e copie.

 

Etapa 2: Solicitando uma Subscrição

Requisitos

1. No Diretório, selecione a sua organização e vá até a página detalhes da organização.

 

2. Selecione o menu Authorisation Servers e em actions clique no ícone editar.

 

3. Na página Authorisation Server Information cole a URL obtida na Etapa 1 no campo Notification Webhook Endpoint.

 

 

Etapa 3: Confirmando uma Subscrição

Requisitos

1. De volta ao webhook.site, role para baixo e no campo de texto Raw Context selecione e copie a URL em SubscribeURL para se subscrever no tópico.

 

2. Em uma nova aba do navegador, cole a URL obtida no passo anterior.

 

3. Pronto! A partir daqui, toda e qualquer modificação que ocorra no Diretório será notificada através de eventos.

 

Etapa 4: Analisando um Evento de Notificação

Requisitos

1. No Diretório, selecione a sua organização e vá até a página detalhes da organização.

 

2. Selecione o menu Software Statement e em actions clique no ícone editar.

 

3. Na janela Software Statement Details vá até o campo description e digite qualquer valor e clique no botão Salvar.

 

4. Neste momento, o Diretório irá enviar uma notificação push.

 

5. De volta ao webhook.site, clique no primeiro evento que surge na lista a esquerda da tela.

 

6. Role a tela para baixo e no campo de texto Raw Context localize o novo valor adicionado no atributo description.

 

 

Related content