Events API
Authway has events for many of the things that happens in the service. You can tap into these events and write your own logic by registering a webhook or by using our Event API. Note that webhook feature is only available in the Enterprise edition of the service.
Common Properties in all events
Each event payload also contains properties unique to the event. You can find the unique properties in the individual event documentation.
| Name | Type | Description |
|---|---|---|
| AggregateId | UUID | The unique identifier of the aggregate (information entity) that the event happended for. |
| OwnerId | UUID | The unique identifier of the owner (tenant) that the event belongs to. |
| EventId | UUID | The unique identifier for the event. Can be used for idempotency, logging and more. |
| Occured | DateTime | The date and time (in UTC) when the event occurred. |
| CausedByPersonId | UUID | The unique identifier of the user that caused the event (if any). |
| CausedBy | string | The name of the user that caused the event (if any). |
| TraceId | string | The trace id that can be used to trace different actions that is going on in a system. |
IpAddressLocation Properties
Depending on environment and configuration some events will include location information based on the IP address. Sources for this information can also be different when hosting your-self compared to Authway IDaaS.
| Name | Type | Description |
|---|---|---|
| CountryCode | string | The two-letter country code (3166-1) representing the country. |
| Country | string | The name of the country. |
| Region | string | The name of the region. |
| City | string | The name of the city. |
| Latitude | decimal | The latitude. |
| Longitude | decimal | The longitude. |
When an IpAddressLocaiton exist in the event, we garuantee that the CountryCode and Country is set, but the other properties will depend on information availability in the source.
Available Events
Organisation Events
To retrieve all organisation events you use the topic “organisation”.
- OrganisationCreated
- OrganisationUpdated
- OrganisationDeleted
- OrganisationClaimAdded
- OrganisationClaimRemoved
- TrustedDomainAdded
- TrustedDomainRemoved
Person Events
To retrieve all organisation events you use the topic “person”.
User Events
To retrieve all organisation events you use the topic “user”.
- UserCreated
- UserUpdated
- UserDeleted
- UserInvited
- UserLoginAdded
- UserLoginRemoved
- UserUsernameChanged
- UserPasswordChanged
- UserPasswordRemoved
- UserRoleAdded
- UserRoleRemoved
- UserSignInAssociated
- UserSignedIn
- UserSignedOut
- UserSignInFailed
- UserLockedout
- UserUnlocked
- UserConfirmedEmail
- UserConfirmedPhoneNumber
- UserClaimAdded
- UserClaimRemoved
Organisation module Events
To retrieve all organisation module events you use the topic “organisationmodule”.
- ModuleActivatedForOrganisation
- ModuleInactivatedForOrganisation
- ModulePayedForOrganisation
- ModuleUnpayedForOrganisation
Module Events
To retrieve all module events you use the topic “module”.