This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Log event

Store a custom event

Example Usage

CustomEvent evt = new CustomEvent();

driver.log_event('appium', 'funEvent')

// example
driver.logEvent('appium', 'funEvent')

// wd example
// WD code here

# ruby_lib example
driver.log_event vendor: 'appium', event: 'funEvent'

# ruby_lib_core example
@driver.logs.event vendor: 'appium', event: 'funEvent'
@driver.logs.event = { vendor: 'appium', event: 'anotherEvent' }

// csharp Code here


This API allows us to store a custom event.

Appium provides Appium Event Timing to track when events happen. This custom event feature allow users to store a custom event as the feature.


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.16.0+ All
UIAutomation 8.0 to 9.3 1.16.0+ All
Android Espresso ?+ 1.16.0+ All
UiAutomator2 ?+ 1.16.0+ All
UiAutomator 4.3+ 1.16.0+ All
Mac Mac ?+ 1.16.0+ All
Windows Windows 10+ 1.16.0+ All

Appium Clients

Language Support Documentation
Java All
Python All
Javascript (WebdriverIO) None
Javascript (WD) None
Ruby All
C# None

HTTP API Specifications


POST /session/:session_id/appium/log_event

URL Parameters


JSON Parameters

name type description
vendor string The name of vendor. It will be vendor in vendor:event.
event string The name of event. It will be event in vendor:event.



See Also