Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to generate user events within the PBX environment. It is useful for automating and triggering custom user events in specific Stasis applications, allowing integration and control over telephony workflows. For example, it can be used to send custom event notifications to an application managing call handling or to trigger specific actions based on user-defined events.

Use Case Examples

1. Trigger a custom user event named 'MyCustomEvent' in a Stasis application called 'my-stasis-app' to notify the application of a specific call state change.
2. Send a user event with additional variables to pass custom data to the application for dynamic call routing or logging.

Properties

Output

JSON

• eventName - The name of the generated user event.
• application - The target application that received the event.
• source - The URI source of the event, if provided.
• variables - Custom variables included in the event, if any.

Dependencies

• Requires an API key credential for authenticating with the Asterisk REST Interface (ARI).

Troubleshooting

• Ensure the base URL and credentials for the Asterisk ARI are correctly configured to avoid authentication errors.
• Verify that the specified application name matches a running Stasis application to prevent event delivery failures.
• Check the format of the source URI and JSON variables to avoid malformed event data errors.

Links

• Asterisk ARI User Guide - Official documentation for the Asterisk REST Interface, detailing how to use ARI to manage applications and events.