https://github.com/vymalo/keycloak-mailchimp
Keycloak Mailchimp Plugin for adding users to Mailchimp
https://github.com/vymalo/keycloak-mailchimp
event-listener keycloak keycloak-event keycloak-event-provider keycloak-mailchimp keycloak-spi mailchimp
Last synced: 6 months ago
JSON representation
Keycloak Mailchimp Plugin for adding users to Mailchimp
- Host: GitHub
- URL: https://github.com/vymalo/keycloak-mailchimp
- Owner: vymalo
- Created: 2020-08-25T18:56:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-17T14:44:14.000Z (almost 2 years ago)
- Last Synced: 2023-06-17T15:51:39.320Z (almost 2 years ago)
- Topics: event-listener, keycloak, keycloak-event, keycloak-event-provider, keycloak-mailchimp, keycloak-spi, mailchimp
- Language: Java
- Homepage: https://blog.ssegning.com
- Size: 146 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Keycloak Mailchimp
## ⚠️ Depreciation notice ⚠️
I'm not working on this plugin anymore, because I think, given the direction Keycloak is taking, it would be better to have this functionality as an external service, outside Keycloak.
I suggest using a plugin like [this](https://github.com/jessylenne/keycloak-event-listener-http) or [this other](https://github.com/softwarefactory-project/keycloak-event-listener-mqtt) to send events to that other service, which would handle things better.
## Usage
After installing the plugin, it should normally create an endpoint __UNPROTECTED__ at `:/realms//mailchimp-resource/config`. You can call it to get the current mailchimp configuration.
Because it is not protected, you can POST EndPoint to create a new configuration for mailchimp to send a request. Then configure the plugin on the administration page. Example:
```json
{
"apiKey": "mailchimp-api-key",
"listId": "mailchimp-list-id",
"listenedEvents": [
"LOGIN", "REGISTER"
]
}
```
As we are working with Keycloak, keep in mind that the events handled by Keycloak are enums imported from `org.keycloak.events.EventType`.
You will then have a configuration for a specific domain. That's it. The rest is under the hood.
## Under the hood
1. Event Listener Provider
2. JPA entity provider
3. Resource provider
These providers are used to keep the plugin configuration running.
## Links
- https://github.com/p2-inc/keycloak-events