> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lokalise

> How to set up the Lokalise connector, plus the actions and events that are available.

![Lokalise](https://stackone-logos.com/api/lokalise/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/lokalise/changelog.md)

[111 actions](#actions) · [33 events](#events) · 1 auth method

Translation
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/lokalise/guides/connector-profile/api-token.md)
>
> Generate your API token from your Lokalise Profile Settings under the API tokens tab.

Optionally, configure receiving Events for Lokalise into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/lokalise/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/lokalise/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

111 actions

ActionDescription

List Project Comments`lokalise_list_project_comments`

List all comments across a project.

List Key Comments`lokalise_list_key_comments`

List all comments for a specific key.

Create Comment`lokalise_create_comment`

Add a comment to a translation key.

Get Comment`lokalise_get_comment`

Retrieve a specific comment.

Delete Comment`lokalise_delete_comment`

Delete a comment from a translation key.

List Contributors`lokalise_list_contributors`

List all contributors in a project.

Create Contributors`lokalise_create_contributors`

Add contributors to a project.

Get Contributor`lokalise_get_contributor`

Retrieve a specific contributor from a project.

Get Current Contributor`lokalise_get_current_contributor`

Retrieve the contributor profile of the authenticated user.

Update Contributor`lokalise_update_contributor`

Update a contributor's role or language permissions.

Delete Contributor`lokalise_delete_contributor`

Remove a contributor from a project.

List Custom Translation Statuses`lokalise_list_custom_translation_statuses`

List all custom translation statuses in a project.

Create Custom Translation Status`lokalise_create_custom_translation_status`

Create a new custom translation status.

Get Custom Translation Status`lokalise_get_custom_translation_status`

Retrieve a specific custom translation status.

Update Custom Translation Status`lokalise_update_custom_translation_status`

Update a custom translation status.

Delete Custom Translation Status`lokalise_delete_custom_translation_status`

Delete a custom translation status.

Get Available Status Colors`lokalise_get_custom_translation_status_colors`

Retrieve the list of available colors for custom translation statuses.

List Files`lokalise_list_files`

List all files in a project.

Upload File`lokalise_upload_file`

Upload a translation file to a project.

Download Files`lokalise_download_files`

Download all translation files from a project.

Download Files (Async)`lokalise_download_files_async`

Asynchronously download translation files from a project.

Delete File`lokalise_delete_file`

Delete a file from a project.

List Glossary Terms`lokalise_list_glossary_terms`

List all glossary terms in a project.

Create Glossary Terms`lokalise_create_glossary_terms`

Add glossary terms to a project.

Get Glossary Term`lokalise_get_glossary_term`

Retrieve a specific glossary term.

Update Glossary Terms`lokalise_update_glossary_terms`

Update existing glossary terms.

Delete Glossary Terms`lokalise_delete_glossary_terms`

Delete glossary terms from a project.

List Unified Groups`lokalise_unified_list_groups`

List unified groups in a Lokalise team.

Get Unified Group`lokalise_unified_get_group`

Get a unified Lokalise group by ID.

List Unified Organizations`lokalise_unified_list_organizations`

List unified organizations in Lokalise.

Get Unified Organization`lokalise_unified_get_organization`

Get a unified Lokalise organization by ID.

List Unified Resource Users`lokalise_unified_list_resource_users`

List Lokalise users with access to an organization or project, and their resource-scoped role.

List Unified Resource Types`lokalise_unified_list_resource_types`

List the resource types Lokalise supports for unified\_list\_resource\_users.

List Unified Roles`lokalise_unified_list_roles`

List unified roles in Lokalise.

Get Unified Role`lokalise_unified_get_role`

Get a unified Lokalise role by ID.

List Unified Users`lokalise_unified_list_users`

List unified users in a Lokalise team.

Get Unified User`lokalise_unified_get_user`

Get a unified Lokalise user by ID.

Create JWT Token`lokalise_create_jwt_token`

Create a service JWT token for OTA SDK authentication.

List Keys`lokalise_list_keys`

List all translation keys in a project.

Create Keys`lokalise_create_keys`

Create one or more translation keys in a project.

Get Key`lokalise_get_key`

Retrieve a specific translation key by ID.

Update Key`lokalise_update_key`

Update a translation key's properties.

Multi-update Keys`lokalise_bulk_update_keys`

Update multiple translation keys at once.

Delete Key`lokalise_delete_key`

Delete a specific translation key.

Delete Multiple Keys`lokalise_delete_keys`

Delete multiple translation keys by IDs.

List System Languages`lokalise_list_system_languages`

List all supported languages in the Lokalise system.

List Project Languages`lokalise_list_project_languages`

List all languages enabled in a project.

Create Languages`lokalise_create_languages`

Add one or more languages to a project.

Get Language`lokalise_get_language`

Retrieve a specific language from a project.

Update Language`lokalise_update_language`

Update a language's settings in a project.

Delete Language`lokalise_delete_language`

Remove a language from a project.

List Orders`lokalise_list_orders`

List all translation orders for a team.

Create Order`lokalise_create_order`

Place a new professional translation order.

Get Order`lokalise_get_order`

Retrieve a specific translation order.

List Payment Cards`lokalise_list_payment_cards`

List all payment cards on file.

Create Payment Card`lokalise_create_payment_card`

Add a new payment card.

Get Payment Card`lokalise_get_payment_card`

Retrieve a specific payment card.

Delete Payment Card`lokalise_delete_payment_card`

Remove a payment card from the account.

List Permission Templates`lokalise_list_permission_templates`

List all permission templates available for a team.

List Projects`lokalise_list_projects`

List all projects accessible to the authenticated user.

Create Project`lokalise_create_project`

Create a new Lokalise project.

Get Project`lokalise_get_project`

Retrieve details of a specific project.

Update Project`lokalise_update_project`

Update an existing project's settings.

Delete Project`lokalise_delete_project`

Delete a project and all its data.

Empty Project`lokalise_empty_project`

Remove all keys and translations from a project.

List Queued Processes`lokalise_list_queued_processes`

List all queued processes in a project.

Get Queued Process`lokalise_get_queued_process`

Retrieve the status of a specific queued process.

List Screenshots`lokalise_list_screenshots`

List all screenshots in a project.

Create Screenshots`lokalise_create_screenshots`

Upload screenshots to a project.

Get Screenshot`lokalise_get_screenshot`

Retrieve a specific screenshot.

Update Screenshot`lokalise_update_screenshot`

Update a screenshot's metadata or associated keys.

Delete Screenshot`lokalise_delete_screenshot`

Delete a screenshot from a project.

List Segments`lokalise_list_segments`

List all segments for a key-language pair.

Get Segment`lokalise_get_segment`

Retrieve a specific segment.

Update Segment`lokalise_update_segment`

Update a specific translation segment.

List Snapshots`lokalise_list_snapshots`

List all snapshots of a project.

Create Snapshot`lokalise_create_snapshot`

Create a snapshot (backup) of a project.

Restore Snapshot`lokalise_restore_snapshot`

Restore a project from a snapshot.

Delete Snapshot`lokalise_delete_snapshot`

Delete a project snapshot.

List Tasks`lokalise_list_tasks`

List all translation tasks in a project.

Create Task`lokalise_create_task`

Create a new translation task in a project.

Get Task`lokalise_get_task`

Retrieve a specific translation task.

Update Task`lokalise_update_task`

Update a translation task's properties.

Delete Task`lokalise_delete_task`

Delete a translation task.

List Groups`lokalise_list_groups`

List all permission groups in a team.

Create Group`lokalise_create_group`

Create a new permission group in a team.

Get Group`lokalise_get_group`

Retrieve a specific permission group.

Update Group`lokalise_update_group`

Update a permission group's name, rights, or language access.

Delete Group`lokalise_delete_group`

Delete a permission group from a team.

Add Projects To Group`lokalise_add_projects_to_group`

Add projects to a permission group.

Remove Projects From Group`lokalise_remove_projects_from_group`

Remove projects from a permission group.

Add Members To Group`lokalise_add_members_to_group`

Add team users to a permission group.

Remove Members From Group`lokalise_remove_members_from_group`

Remove team users from a permission group.

List Teams`lokalise_list_teams`

List all teams the authenticated user belongs to.

Get Team`lokalise_get_team`

Retrieve details of a specific team.

List Team Users`lokalise_list_team_users`

List all users in a team.

Get Team User`lokalise_get_team_user`

Retrieve a specific team user.

Update Team User`lokalise_update_team_user`

Update a team user's role.

Delete Team User`lokalise_delete_team_user`

Remove a user from a team.

List Translation Providers`lokalise_list_translation_providers`

List all available translation providers for a team.

Get Translation Provider`lokalise_get_translation_provider`

Retrieve details of a specific translation provider.

List Translations`lokalise_list_translations`

List all translations in a project.

Get Translation`lokalise_get_translation`

Retrieve a specific translation by ID.

Update Translation`lokalise_update_translation`

Update the value or status of a translation.

Get User`lokalise_get_user`

Retrieve basic profile data for a user.

List Webhooks`lokalise_list_webhooks`

List all webhooks in a project.

Create Webhook`lokalise_create_webhook`

Create a new webhook for a project.

Get Webhook`lokalise_get_webhook`

Retrieve a specific webhook.

Update Webhook`lokalise_update_webhook`

Update an existing webhook's configuration.

Delete Webhook`lokalise_delete_webhook`

Delete a webhook from a project.

Regenerate Webhook Secret`lokalise_regenerate_webhook_secret`

Regenerate the secret for a webhook.

## Events

Tags

Select all
|
Clear

Branches

Comments

Contributors

Files

Keys

Languages

Orders

Projects

Snapshots

Tasks

Translations

Webhooks

No tags found

33 events

EventDescriptionTags

Active Check`lokalise_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`lokalise_webhook_project_imported`Manual setup

Fired when a translation file is uploaded to a project (project.imported).

FilesWebhooks

Project Exported`lokalise_webhook_project_exported`Manual setup

Fired when translation files are downloaded from a project (project.exported).

FilesWebhooks

Project Copied`lokalise_webhook_project_copied`Manual setup

Fired when a project is copied (project.copied).

ProjectsWebhooks

Project Snapshot Created`lokalise_webhook_project_snapshot`Manual setup

Fired when a project snapshot is created (project.snapshot).

SnapshotsWebhooks

Branch Added`lokalise_webhook_project_branch_added`Manual setup

Fired when a project branch is created (project.branch.added).

BranchesWebhooks

Branch Deleted`lokalise_webhook_project_branch_deleted`Manual setup

Fired when a project branch is deleted (project.branch.deleted).

BranchesWebhooks

Branch Merged`lokalise_webhook_project_branch_merged`Manual setup

Fired when a project branch is merged into another branch (project.branch.merged).

BranchesWebhooks

Languages Added`lokalise_webhook_project_languages_added`Manual setup

Fired when one or more languages are added to a project (project.languages.added).

LanguagesWebhooks

Language Removed`lokalise_webhook_project_language_removed`Manual setup

Fired when a language is removed from a project (project.language.removed).

LanguagesWebhooks

Language Settings Changed`lokalise_webhook_project_language_settings_changed`Manual setup

Fired when a project language's settings are changed (project.language.settings\_changed).

LanguagesWebhooks

Key Added`lokalise_webhook_project_key_added`Manual setup

Fired when a single translation key is added to a project (project.key.added).

KeysWebhooks

Keys Added (Bulk)`lokalise_webhook_project_keys_added`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`lokalise_webhook_project_key_modified`Manual setup

Fired when a single translation key is modified (project.key.modified).

KeysWebhooks

Keys Modified (Bulk)`lokalise_webhook_project_keys_modified`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`lokalise_webhook_project_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`lokalise_webhook_project_key_comment_added`Manual setup

Fired when a comment is added to a translation key (project.key.comment.added).

CommentsWebhooks

Translation Updated`lokalise_webhook_project_translation_updated`Manual setup

Fired when a single translation is modified (project.translation.updated).

TranslationsWebhooks

Translations Updated (Bulk)`lokalise_webhook_project_translations_updated`Manual setup

Fired when translations are modified in bulk, for example by translation memory, machine translation or a file upload (p...

TranslationsWebhooks

Translation Reviewed`lokalise_webhook_project_translation_proofread`Manual setup

Fired when a translation is marked or unmarked as reviewed (project.translation.proofread).

TranslationsWebhooks

Translations Reviewed (Bulk)`lokalise_webhook_project_translations_proofread`Manual setup

Fired when several translations are marked or unmarked as reviewed at once, for example through an API multicall (projec...

TranslationsWebhooks

Contributor Added`lokalise_webhook_project_contributor_added`Manual setup

Fired when an admin adds a contributor to a project (project.contributor.added).

ContributorsWebhooks

Contributor Joined via Public Link`lokalise_webhook_project_contributor_added_public`Manual setup

Fired when a contributor adds themselves to a project through the public signup link (project.contributor.added\_public).

ContributorsWebhooks

Contributor Removed`lokalise_webhook_project_contributor_deleted`Manual setup

Fired when a contributor is removed from a project (project.contributor.deleted).

ContributorsWebhooks

Task Created`lokalise_webhook_project_task_created`Manual setup

Fired when a translation or review task is created (project.task.created).

TasksWebhooks

Task Queued`lokalise_webhook_project_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`lokalise_webhook_project_task_closed`Manual setup

Fired when a task is closed, manually by an admin or automatically on completion (project.task.closed).

TasksWebhooks

Task Deleted`lokalise_webhook_project_task_deleted`Manual setup

Fired when a task is deleted (project.task.deleted).

TasksWebhooks

Task Language Closed`lokalise_webhook_project_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`lokalise_webhook_project_task_initial_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`lokalise_webhook_team_order_created`Manual setup

Fired when a professional translation order is created (team.order.created).

OrdersWebhooks

Order Deleted`lokalise_webhook_team_order_deleted`Manual setup

Fired when a translation order is deleted (team.order.deleted).

OrdersWebhooks

Order Completed`lokalise_webhook_team_order_completed`Manual setup

Fired when a translation order is marked completed (team.order.completed).

OrdersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.