Eventos de Webhooks

Este guia lista os diferentes eventos de webhook do Logto e explica quando cada evento ocorre.

Eventos de hook de interação do usuário

Tipo de evento	Descrição
PostRegister	Um usuário cria com sucesso uma nova conta pela interface de usuário.
PostSignIn	Um usuário faz login com sucesso pela interface de usuário.
PostResetPassword	A senha de um usuário é redefinida com sucesso pelo fluxo de "Esqueci minha senha".

Eventos de hook de mutação de dados

Usuário (User)

Tipo de evento	Descrição
User.Created	Uma nova conta de usuário é criada.
User.Deleted	Uma conta de usuário é excluída.
User.Data.Updated	Os dados do perfil do usuário são atualizados, por exemplo, email, avatar, custom.data, identificador social, etc.
User.SuspensionStatus.Updated	O status de suspensão do usuário é alterado (suspenso ou reativado).

Papel (Role)

Tipo de evento	Descrição
Role.Created	Um novo papel é criado.
Role.Deleted	Um papel é excluído.
Role.Data.Updated	Os dados de um papel são atualizados, por exemplo, nome do papel, descrição e status de papel padrão.
Role.Scopes.Updated	Permissões atribuídas a um papel são adicionadas ou removidas.

Permissão (Escopo) (Permission (Scope))

Tipo de evento	Descrição
Scope.Created	Uma nova permissão de API é criada.
Scope.Deleted	Uma permissão de API é excluída.
Scope.Data.Updated	Os dados de uma permissão de API são atualizados, por exemplo, descrição da permissão.

Organização (Organization)

Tipo de evento	Descrição
Organization.Created	Uma nova organização é criada.
Organization.Deleted	Uma organização é excluída.
Organization.Data.Updated	Os dados de uma organização são atualizados, por exemplo, nome da organização, descrição, custom.data, etc.
Organization.Membership.Updated	Usuários ou aplicativos são adicionados ou removidos de uma organização. O payload inclui campos delta de associação.

Papel da organização (Organization role)

Tipo de evento	Descrição
OrganizationRole.Created	Um novo papel de organização é criado.
OrganizationRole.Deleted	Um papel de organização é excluído.
OrganizationRole.Data.Updated	Os dados de um papel de organização são atualizados, por exemplo, nome e descrição do papel da organização.
OrganizationRole.Scopes.Updated	Permissões atribuídas a um papel de organização são adicionadas ou removidas.

Permissão da organização (escopo) (Organization permission (scope))

Tipo de evento	Descrição
OrganizationScope.Created	Uma nova permissão de organização é criada.
OrganizationScope.Deleted	Uma permissão de organização é excluída.
OrganizationScope.Data.Updated	Os dados de uma permissão de organização são atualizados, por exemplo, descrição da permissão da organização.

Eventos disparados pela Management API

Endpoint da API	Evento
POST /users	User.Created
DELETE /users/:userId	User.Deleted
PATCH /users/:userId	User.Data.Updated
PATCH /users/:userId/custom-data	User.Data.Updated
PATCH /users/:userId/profile	User.Data.Updated
PATCH /users/:userId/password	User.Data.Updated
PATCH /users/:userId/is-suspended	User.SuspensionStatus.Updated
POST /roles	Role.Created, (Role.Scopes.Update)
DELETE /roles/:id	Role.Deleted
PATCH /roles/:id	Role.Data.Updated
POST /roles/:id/scopes	Role.Scopes.Updated
DELETE /roles/:id/scopes/:scopeId	Role.Scopes.Updated
POST /resources/:resourceId/scopes	Scope.Created
DELETE /resources/:resourceId/scopes/:scopeId	Scope.Deleted
PATCH /resources/:resourceId/scopes/:scopeId	Scope.Data.Updated
POST /organizations	Organization.Created
DELETE /organizations/:id	Organization.Deleted
PATCH /organizations/:id	Organization.Data.Updated
PUT /organizations/:id/users	Organization.Membership.Updated
POST /organizations/:id/users	Organization.Membership.Updated
DELETE /organizations/:id/users/:userId	Organization.Membership.Updated
PUT /organizations/:id/applications	Organization.Membership.Updated
POST /organizations/:id/applications	Organization.Membership.Updated
DELETE /organizations/:id/applications/:applicationId	Organization.Membership.Updated
PUT /organization-invitations/:id/status (Accepted)	Organization.Membership.Updated
POST /organization-roles	OrganizationRole.Created, (OrganizationRole.Scopes.Updated)
DELETE /organization-roles/:id	OrganizationRole.Deleted
PATCH /organization-roles/:id	OrganizationRole.Data.Updated
POST /organization-scopes	OrganizationScope.Created
DELETE /organization-scopes/:id	OrganizationScope.Deleted
PATCH /organization-scopes/:id	OrganizationScope.Data.Updated
PUT /organization-roles/:id/scopes	OrganizationRole.Scopes.Updated
POST /organization-roles/:id/scopes	OrganizationRole.Scopes.Updated
DELETE /organization-roles/:id/scopes/:organizationScopeId	OrganizationRole.Scopes.Updated

Eventos disparados pela Experience API

Ação de interação do usuário	Evento
Vinculação de email/telefone do usuário	User.Data.Updated
Vinculação de MFA do usuário	User.Data.Updated
Vinculação social/SSO do usuário	User.Data.Updated
Redefinição de senha do usuário	User.Data.Updated
Registro do usuário	User.Created
Usuário provisionado automaticamente em uma organização via provisionamento Just-in-Time (domínio de email correspondente ou conector SSO corporativo)	Organization.Membership.Updated

Eventos de hook de exceção

Segurança (Security)

Tipo de evento	Descrição
Identifier.Lockout	Uma conta de usuário é bloqueada devido a tentativas consecutivas de verificação de identidade falhadas. Pode ser disparado nos seguintes fluxos: Falha na verificação de senha Falha na verificação de código Falha na verificação de token único
Message.RateLimited	Um usuário final excede o limite de envio por destinatário para códigos de verificação. Dispara apenas nos caminhos de envio do usuário final (Experience API e Account API), com payload { action, recipient }.

Perguntas frequentes (FAQs)

Qual a diferença entre PostRegister e User.Created?

PostRegister é disparado quando um usuário cria com sucesso uma nova conta pelo fluxo de cadastro do usuário; User.Created é disparado quando uma nova conta de usuário é criada através da Management API.