Script Event Listeners

Use Cases#

Script event listeners suit scenarios that require simple event handling logic, quick prototyping, configuration-driven responses, or implementations without external dependencies. Common use cases include:

• Email Notifications: Send automated emails when new user accounts are created or when password resets occur
• Data Validation: Validate event data before processing or forwarding to external systems
• Attribute Transformation: Transform or enrich event attributes for downstream consumers
• Conditional Logic: Implement business rules that determine whether to process specific events
• Logging and Debugging: Log event details for troubleshooting during development and testing
• Simple Integrations: Forward events to webhooks or REST APIs without complex processing requirements

Script event listeners work best when the logic remains straightforward and does not require external libraries or performance-critical operations. For complex scenarios, consider using event listener plugins instead.

Getting Started#

To create a script event listener, sign in to the Admin UI and navigate to System → Event Listeners. Select the option to create a new event listener.

Provide a name and select Script Event Listener.

Configure the following settings:

1. Procedure — Choose or create a procedure that contains the script logic to run on events. The procedure contains the event handling logic.
2. Service Integrations — Enable optional integrations like Webservice, SMS Sender, Email Sender, Account Manager, or Bucket if the procedure requires access to these services. Enable service integrations only when the script needs to interact with external services or facilities.

For detailed implementation guidance on writing event listener procedures, see the Event Listener Procedures documentation.

Learn more#

For comprehensive documentation on available event types and their properties, refer to the Event Interface Documentation.

For practical implementation guidance and advanced integration patterns:

• Event Listener SDK Documentation - Complete API reference for implementing event listeners
• Scripting Guide - Learn how to write script-based event listeners
• Plugin Development - Build custom event listener plugins
• EventListener procedures - Perform custom actions to server-events