Events

Event actions

Publish an event to a Virtual Environment

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentIdstringRequired

The Environment Id

Body

application/json

namestring · enumRequired

The event name (clipboard_sync, file_download, open_tab, etc.)

Possible values:

datastringRequired

The data to publish

Example: https://www.bing.com

Responses

200

Publish success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Publish Environment Event success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500

Publish failure

application/json

post/v1/events/publish/{environmentId}

HTTPcURLJavaScriptPython

POST /butler/api/v1/events/publish/{environmentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "name": "clipboard_sync",
  "data": "https://www.bing.com"
}

{
  "statusCode": "200",
  "success": "true",
  "message": "Publish Environment Event success",
  "event": "GET",
  "items": []
}