Event

The event object documents relevant activities and changes within a project in the LocaleUI platform. It is used to track user actions, system processes and automated processes, such as uploading files or adding languages.

Events can be used to analyze change histories, trigger notifications or integrate external systems via webhooks. Each event contains metadata such as timestamp, action type, affected entities and the responsible user or system source.

Create an event

The interface allows you to create an event in a project. This is required to import translation files.

Properties:

  • Method: POST
  • Endpoint: https://localeui.com/api/v1/projects/[Project API ID]/events
  • Authentication: Required (bearer token)
  • Path parameters:
    • Project API ID (String) - The unique API ID of the project

Example request:

      
Command line
$ curl -X POST https://localeui.com/api/v1/projects/[Project API ID]/events \ -H "Authorization: Bearer [Your API token]" \ -H "Content-Type: application/json"

Example response:

In response to a valid request to the interface, the created event is returned. Shown in the following example.

      
Response 200 OK
{ "api_id": "evt_12345678901234567890", "kind": "api_upload" }

Response field description

Field
Type
Description
api_id
String
Unique identifier of the event for API purposes.
kind
String
Type of event, e.g. api_upload, language_addition.