Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Optionally, configure receiving Events for Lokalise into StackOne.
Connector Profile · API Token
Generate your API token from your Lokalise Profile Settings under the API tokens tab.
Webhooks setup
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · API Token
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
111 actions
Action
Description
List Project Comments
List all comments across a project.
List Key Comments
List all comments for a specific key.
Create Comment
Add a comment to a translation key.
Get Comment
Retrieve a specific comment.
Delete Comment
Delete a comment from a translation key.
List Contributors
List all contributors in a project.
Create Contributors
Add contributors to a project.
Get Contributor
Retrieve a specific contributor from a project.
Get Current Contributor
Retrieve the contributor profile of the authenticated user.
Update Contributor
Update a contributor’s role or language permissions.
Delete Contributor
Remove a contributor from a project.
List Custom Translation Statuses
List all custom translation statuses in a project.
Create Custom Translation Status
Create a new custom translation status.
Get Custom Translation Status
Retrieve a specific custom translation status.
Update Custom Translation Status
Update a custom translation status.
Delete Custom Translation Status
Delete a custom translation status.
Get Available Status Colors
Retrieve the list of available colors for custom translation statuses.
List Files
List all files in a project.
Upload File
Upload a translation file to a project.
Download Files
Download all translation files from a project.
Download Files (Async)
Asynchronously download translation files from a project.
Delete File
Delete a file from a project.
List Glossary Terms
List all glossary terms in a project.
Create Glossary Terms
Add glossary terms to a project.
Get Glossary Term
Retrieve a specific glossary term.
Update Glossary Terms
Update existing glossary terms.
Delete Glossary Terms
Delete glossary terms from a project.
List Unified Groups
List unified groups in a Lokalise team.
Get Unified Group
Get a unified Lokalise group by ID.
List Unified Organizations
List unified organizations in Lokalise.
Get Unified Organization
Get a unified Lokalise organization by ID.
List Unified Resource Users
List Lokalise users with access to an organization or project, and their resource-scoped role.
List Unified Resource Types
List the resource types Lokalise supports for unified_list_resource_users.
List Unified Roles
List unified roles in Lokalise.
Get Unified Role
Get a unified Lokalise role by ID.
List Unified Users
List unified users in a Lokalise team.
Get Unified User
Get a unified Lokalise user by ID.
Create JWT Token
Create a service JWT token for OTA SDK authentication.
List Keys
List all translation keys in a project.
Create Keys
Create one or more translation keys in a project.
Get Key
Retrieve a specific translation key by ID.
Update Key
Update a translation key’s properties.
Multi-update Keys
Update multiple translation keys at once.
Delete Key
Delete a specific translation key.
Delete Multiple Keys
Delete multiple translation keys by IDs.
List System Languages
List all supported languages in the Lokalise system.
List Project Languages
List all languages enabled in a project.
Create Languages
Add one or more languages to a project.
Get Language
Retrieve a specific language from a project.
Update Language
Update a language’s settings in a project.
Delete Language
Remove a language from a project.
List Orders
List all translation orders for a team.
Create Order
Place a new professional translation order.
Get Order
Retrieve a specific translation order.
List Payment Cards
List all payment cards on file.
Create Payment Card
Add a new payment card.
Get Payment Card
Retrieve a specific payment card.
Delete Payment Card
Remove a payment card from the account.
List Permission Templates
List all permission templates available for a team.
List Projects
List all projects accessible to the authenticated user.
Create Project
Create a new Lokalise project.
Get Project
Retrieve details of a specific project.
Update Project
Update an existing project’s settings.
Delete Project
Delete a project and all its data.
Empty Project
Remove all keys and translations from a project.
List Queued Processes
List all queued processes in a project.
Get Queued Process
Retrieve the status of a specific queued process.
List Screenshots
List all screenshots in a project.
Create Screenshots
Upload screenshots to a project.
Get Screenshot
Retrieve a specific screenshot.
Update Screenshot
Update a screenshot’s metadata or associated keys.
Delete Screenshot
Delete a screenshot from a project.
List Segments
List all segments for a key-language pair.
Get Segment
Retrieve a specific segment.
Update Segment
Update a specific translation segment.
List Snapshots
List all snapshots of a project.
Create Snapshot
Create a snapshot (backup) of a project.
Restore Snapshot
Restore a project from a snapshot.
Delete Snapshot
Delete a project snapshot.
List Tasks
List all translation tasks in a project.
Create Task
Create a new translation task in a project.
Get Task
Retrieve a specific translation task.
Update Task
Update a translation task’s properties.
Delete Task
Delete a translation task.
List Groups
List all permission groups in a team.
Create Group
Create a new permission group in a team.
Get Group
Retrieve a specific permission group.
Update Group
Update a permission group’s name, rights, or language access.
Delete Group
Delete a permission group from a team.
Add Projects To Group
Add projects to a permission group.
Remove Projects From Group
Remove projects from a permission group.
Add Members To Group
Add team users to a permission group.
Remove Members From Group
Remove team users from a permission group.
List Teams
List all teams the authenticated user belongs to.
Get Team
Retrieve details of a specific team.
List Team Users
List all users in a team.
Get Team User
Retrieve a specific team user.
Update Team User
Update a team user’s role.
Delete Team User
Remove a user from a team.
List Translation Providers
List all available translation providers for a team.
Get Translation Provider
Retrieve details of a specific translation provider.
List Translations
List all translations in a project.
Get Translation
Retrieve a specific translation by ID.
Update Translation
Update the value or status of a translation.
Get User
Retrieve basic profile data for a user.
List Webhooks
List all webhooks in a project.
Create Webhook
Create a new webhook for a project.
Get Webhook
Retrieve a specific webhook.
Update Webhook
Update an existing webhook’s configuration.
Delete Webhook
Delete a webhook from a project.
Regenerate Webhook Secret
Regenerate the secret for a webhook.
Events
|
No tags found
33 events
Event
Description
Tags
Active Check
Manual setup
Responds with 200 OK to the Lokalise ping and to any delivery that does not match a known event.
Webhooks
Project Imported
Manual setup
Fired when a translation file is uploaded to a project (project.imported).
FilesWebhooks
Project Exported
Manual setup
Fired when translation files are downloaded from a project (project.exported).
FilesWebhooks
Project Copied
Manual setup
Fired when a project is copied (project.copied).
ProjectsWebhooks
Project Snapshot Created
Manual setup
Fired when a project snapshot is created (project.snapshot).
SnapshotsWebhooks
Branch Added
Manual setup
Fired when a project branch is created (project.branch.added).
BranchesWebhooks
Branch Deleted
Manual setup
Fired when a project branch is deleted (project.branch.deleted).
BranchesWebhooks
Branch Merged
Manual setup
Fired when a project branch is merged into another branch (project.branch.merged).
BranchesWebhooks
Languages Added
Manual setup
Fired when one or more languages are added to a project (project.languages.added).
LanguagesWebhooks
Language Removed
Manual setup
Fired when a language is removed from a project (project.language.removed).
LanguagesWebhooks
Language Settings Changed
Manual setup
Fired when a project language’s settings are changed (project.language.settings_changed).
LanguagesWebhooks
Key Added
Manual setup
Fired when a single translation key is added to a project (project.key.added).
KeysWebhooks
Keys Added (Bulk)
Manual setup
Fired when keys are added to a project in bulk, by file upload, or by copy or move (project.keys.added).
KeysWebhooks
Key Modified
Manual setup
Fired when a single translation key is modified (project.key.modified).
KeysWebhooks
Keys Modified (Bulk)
Manual setup
Fired when keys are modified by a bulk action, a replace, a file upload or an API call (project.keys.modified).
KeysWebhooks
Keys Deleted
Manual setup
Fired when keys are deleted from a project, individually, in bulk, by a move or through the API (project.keys.deleted).
KeysWebhooks
Key Comment Added
Manual setup
Fired when a comment is added to a translation key (project.key.comment.added).
CommentsWebhooks
Translation Updated
Manual setup
Fired when a single translation is modified (project.translation.updated).
TranslationsWebhooks
Translations Updated (Bulk)
Manual setup
Fired when translations are modified in bulk, for example by translation memory, machine translation or a file upload (p…
TranslationsWebhooks
Translation Reviewed
Manual setup
Fired when a translation is marked or unmarked as reviewed (project.translation.proofread).
TranslationsWebhooks
Translations Reviewed (Bulk)
Manual setup
Fired when several translations are marked or unmarked as reviewed at once, for example through an API multicall (projec…
TranslationsWebhooks
Contributor Added
Manual setup
Fired when an admin adds a contributor to a project (project.contributor.added).
ContributorsWebhooks
Contributor Joined via Public Link
Manual setup
Fired when a contributor adds themselves to a project through the public signup link (project.contributor.added_public).
ContributorsWebhooks
Contributor Removed
Manual setup
Fired when a contributor is removed from a project (project.contributor.deleted).
ContributorsWebhooks
Task Created
Manual setup
Fired when a translation or review task is created (project.task.created).
TasksWebhooks
Task Queued
Manual setup
Fired when a new review task is queued behind an unfinished parent task or translation order (project.task.queued).
TasksWebhooks
Task Closed
Manual setup
Fired when a task is closed, manually by an admin or automatically on completion (project.task.closed).
TasksWebhooks
Task Deleted
Manual setup
Fired when a task is deleted (project.task.deleted).
TasksWebhooks
Task Language Closed
Manual setup
Fired when one language of a task is closed, manually or on completion (project.task.language.closed).
TasksWebhooks
Task TM Leverage Calculated
Manual setup
Fired when Lokalise finishes calculating the initial translation memory leverage for a task (project.task.initial_tm_lev…
TasksWebhooks
Order Created
Manual setup
Fired when a professional translation order is created (team.order.created).
OrdersWebhooks
Order Deleted
Manual setup
Fired when a translation order is deleted (team.order.deleted).
OrdersWebhooks
Order Completed
Manual setup
Fired when a translation order is marked completed (team.order.completed).
OrdersWebhooks