Get custom events list

Custom events collection contains a list of all custom events. All active custom events can be downloaded. Specifying a single custom event ID can be used to retrieve detailed information about a specific event.

Request data format

Request URL parameters:

Parameters	Type	Notes
apiKey	string	Your API key, required for authentication. Required.

Examples:

https://api.esv2.com/v2/Api/WorkflowCustomEvent?apiKey=YOUR_API_KEY_HERE

Get custom event by custom event ID

Request URL parameters:

Parameters	Type	Notes
apiKey	string	Your API key, required for authentication. Required.
ID	int	Workflow custom event ID. Required as a part of address (not GET parameter). See example below.
startDate	datetime	Optional. The date from which we want to check the occurrence of a custom event.
endDate	datetime	Optional. Date to when we want to check the occurrence of a custom event.

Examples:

https://api.esv2.com/v2/Api/WorkflowCustomEvent/123?apiKey=YOUR_API_KEY_HERE
https://api.esv2.com/v2/Api/WorkflowCustomEvents/123?apiKey=YOUR_API_KEY_HERE&startDate=2024-12-06%2011:22:00&endDate=2024-12-06%2012:37:00

Response

Get multiple custom events

Response Data element:

Parameters	Type	Notes
CustomEvents	array[complex]	Array of custom event elements.

Custom event element children:

Parameters	Type	Notes
Id	int	Custom event identifier.
Name	string	Custom event name.
IsLoggingEnabled	boolean	Information about logging enabled.

Get custom event by custom event ID

Response Data element:

Parameters	Type	Notes
Id	int	Custom event identifier.
Name	string	Custom event name.
IsLoggingEnabled	boolean	Information about logging enabled.
OccurrenceCount	int	Number of appearances of a given custom event

Examples

Get multiple custom events

Request:

GET 
https://api.esv2.com/v2/Api/WorkflowCustomEvent?apiKey=test_api_key  
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

OK response:

{
    "Data": {
        "CustomEvents": [
            {
                "Id": 1,
                "Name": "test custom event",
                "IsLoggingEnabled": true
            },
            {
                "Id": 4,
                "Name": "test",
                "IsLoggingEnabled": true
            },
            {
                "Id": 7,
                "Name": "test event",
                "IsLoggingEnabled": false
            }
        ]
    }
}

Get custom event by custom event ID

Request:

GET 
https://api.esv2.com/v2/Api/WorkflowCustomEvents/123?apiKey=YOUR_API_KEY_HERE&startDate=2024-12-06%2011:22:00&endDate=2024-12-06%2012:37:00
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

OK response:

{
    "Data": {
        "Id": 123,
        "Name": "My custom event",
        "IsLoggingEnabled": true,
        "OccurrenceCount": 6
    }
}