Event Tools
Overview
Event tools manage Logic Fabric event definitions and event handlers in Logic Assist. An event definition describes an event that can be raised in the system, while an event handler binds an event definition to a Logic Flow so that the flow runs when the event fires - either synchronously or asynchronously. These tools require the Logic Composer product.
search_event_definitions
Searches Logic Fabric event definitions by name.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventName | string | ✓ | The name of the event definition to search for. |
Returns: Matching event definitions including name, title, description, and project.
list_event_definitions
Lists Logic Fabric event definitions.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | The ID of the project to filter event definitions by. Optional. | |
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.
get_event_definition_details
Gets the details for a Logic Fabric 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 a preview URL for a Logic Fabric event definition.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventDefinitionId | GUID | ✓ | The ID of 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 Logic Fabric event definition and returns the event definition id.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventDefinitionName | string | ✓ | The name of the event definition to create. |
projectId | GUID | ✓ | The ID 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 Logic Fabric event definition metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventDefinitionId | GUID | ✓ | The ID of the event definition to update. |
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. See Managed Solution Protection.
Best practice: Always call get_event_definition_details first to read the current metadata before updating, to avoid unintentionally overwriting parts of the definition you did not intend to change.
get_event_definition_handlers
Gets Logic Fabric 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 Logic Fabric event handler and returns the event handler ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventHandlerName | string | ✓ | The name of the event handler to create. |
projectId | GUID | ✓ | The ID of the project to create the event handler in. |
eventDefinitionId | GUID | ✓ | The ID of the event definition. |
logicFlowId | GUID | ✓ | The ID of the logic flow. |
metadata | string | ✓ | The metadata for the event handler in JSON format. |
async | bool | ✓ | Indicates whether the event handler runs asynchronously. |
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. See Managed Solution Protection.
update_event_handler
Updates a Logic Fabric event handler.
| Parameter | Type | Required | Description |
|---|---|---|---|
eventHandlerId | GUID | ✓ | The ID of the event handler. |
metadata | string | ✓ | The metadata for the event handler in JSON format. |
async | bool | ✓ | Indicates whether the event handler runs asynchronously. |
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.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
Best practice: Always call get_event_definition_handlers first to read the current handler metadata before updating, to avoid unintentionally overwriting parts of the definition you did not intend to change.