Event Tools

Overview

Event tools provide full lifecycle management for Flowon Event Definitions and Event Handlers. Event Definitions describe custom events that can be raised in the system, while Event Handlers bind a Logic Flow to respond when a specific event fires - either synchronously or asynchronously.

`list_all_event_definitions`

Lists All Flowon event definitions.

Parameter	Type	Required	Description
`pageNumber`	int		The page number for pagination. If not provided, defaults to the first page.
`pagingCookie`	string		The paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve.

Returns: A paginated list of Event Definitions including name, title, description, and project.

See Pagination for details on iterating through large result sets.

`list_event_definitions_by_project_name`

Lists Flowon event definitions by project name.

Parameter	Type	Required	Description
`projectName`	string	✓	The name of the project to filter event definitions by name.

Returns: A list of Event Definitions within the specified project.

`list_event_definitions_by_project_id`

Lists Flowon event definitions by project ID.

Parameter	Type	Required	Description
`projectId`	GUID	✓	The ID of the project to filter event definitions by.

Returns: A list of Event Definitions within the specified project.

`get_event_definition_details_by_name`

Gets the details for a Flowon event definition by event definition name.

Parameter	Type	Required	Description
`eventDefinitionName`	string	✓	The name of the event definition.
`projectName`	string	✓	The name of the project the event definition belongs to.

Returns: Full Event Definition details including name, metadata, title, description, and project.

`get_event_definition_details_by_id`

Gets the details for a Flowon event definition by event definition id.

Parameter	Type	Required	Description
`eventDefinitionId`	GUID	✓	The ID of the event definition.
`projectName`	string	✓	The name of the project the event definition belongs to.

Returns: Full Event Definition details including name, metadata, title, description, and project.

`get_event_definition_preview_url`

Get preview url for Flowon event definition.

Parameter	Type	Required	Description
`eventDefinitionName`	string	✓	The name of the event definition.
`projectName`	string	✓	The name of the project for the event definition.
`metadata`	string	✓	The metadata for the event definition in JSON format.
`title`	string		The title for the event definition. Optional.
`description`	string		The description for the event definition. Optional.

Returns: A preview URL for the event definition record.

`create_event_definition`

Creates a new Flowon event definition and returns the event definition id.

Parameter	Type	Required	Description
`eventDefinitionName`	string	✓	The name of the event definition to create.
`projectName`	string	✓	The name of the project to create the event definition in.
`metadata`	string	✓	The metadata for the event definition in JSON format.
`title`	string		The title for the event definition. Optional.
`description`	string		The description for the event definition. Optional.

Returns: The GUID of the newly created Event Definition and its URL.

Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.

`update_event_definition_metadata`

Updates Flowon event definition metadata.

Parameter	Type	Required	Description
`eventDefinitionName`	string	✓	The name of the event definition to update.
`projectName`	string	✓	The name of the project the event definition belongs to.
`metadata`	string	✓	The updated metadata for the event definition in JSON format.

Returns: Confirmation that the event definition metadata was updated.

Restriction: Cannot be called on projects associated with a managed solution.

`get_event_definition_handlers`

Gets Flowon event definition handlers by event definition ID.

Parameter	Type	Required	Description
`eventDefinitionId`	GUID	✓	The ID of the event definition.

Returns: A list of Event Handlers for the specified event definition, including handler name, linked logic flow ID, project, async flag, title, and description.

`create_event_handler`

Creates a new Flowon event handler and returns the event handler ID.

Parameter	Type	Required	Description
`eventHandlerName`	string	✓	The name of the event handler to create.
`projectName`	string	✓	The name of the project to create the event handler in.
`eventDefinitionId`	GUID	✓	The ID for the event definition.
`logicFlowId`	GUID	✓	The ID for the logic flow.
`metadata`	string	✓	The metadata for the event handler in JSON format.
`async`	bool	✓	Indicates whether the event handler runs async.
`title`	string		The title for the event handler. Optional.
`description`	string		The description for the event handler. Optional.

Returns: The GUID of the newly created Event Handler and its URL.

Restriction: Cannot be called on projects associated with a managed solution.

`update_event_handler`

Updates a Flowon event handler.

Parameter	Type	Required	Description
`eventHandlerId`	GUID	✓	The ID for the event handler.
`metadata`	string	✓	The metadata for the event handler in JSON format.
`async`	bool	✓	Indicates whether the event handler runs async.
`title`	string		The title for the event handler. Optional.
`description`	string		The description for the event handler. Optional.

Returns: Confirmation that the event handler was updated.

Overview​

list_all_event_definitions​

list_event_definitions_by_project_name​

list_event_definitions_by_project_id​

get_event_definition_details_by_name​

get_event_definition_details_by_id​

get_event_definition_preview_url​

create_event_definition​

update_event_definition_metadata​

get_event_definition_handlers​

create_event_handler​

update_event_handler​