Skip to docs navigation

Lokalise integration guide

Verified

How to connect Lokalise to WEXTL and use its 1 trigger and 116 actions in your workflows. About Lokalise: Translation management with projects, keys, translations, files, tasks, orders, contributors and webhooks.

  • 1 trigger
  • 53 searches
  • 63 actions
  • Instant (webhooks)
  • Auth: API key
  • Auth: OAuth

AI-assisted documentation37 min read

This documentation is compiled from our integration source code, internal specs for Lokalise, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Lokalise on WEXTL →
  • Lokalise
  • WEXTL
  • Bitbucket
  • Crowdin
  • Apify
  • CircleCI
  • Alchemy
  • CloudConvert
  • Better Stack
  • AWS S3
  • Box
  • Contentful
  • BugBug
  • Buildkite
  • Agenty
  • Bright Data
  • Currents
  • Browse AI
  • Cloudflare
  • Clerk
  • API Verve
  • AWS Cognito
  • Bunny.net
  • AWS Lambda
  • 0CodeKit
  • Browserless
  • Bitwarden
  • Azure Storage
  • AssemblyAI
  • Cortex
  • Cockpit
  • Adafruit
Credential type option 1

Lokalise - API Token

  • API TokenpasswordRequired

    In Lokalise open your profile, Profile settings, API tokens, and generate a token. Use a Read/write token to change data and a Read-only token for reports. The token can reach every project you can open.[1]

Credential type option 2

Lokalise - OAuth 2.0 (own app)

You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.

  • Client IDtextRequired

    Lokalise registers OAuth 2 apps through its support team: ask them to register an app, and they return a client ID and secret.[1]

  • Client SecretpasswordRequired

    The client secret that Lokalise support returned with the client ID.[1]

Integration requests 39 permissions:

  • read_projects
  • write_projects
  • read_keys
  • write_keys
  • delete_keys
  • read_translations
  • write_translations
  • read_languages
  • write_languages
  • read_files
  • write_files
  • read_tasks
  • write_tasks
  • read_comments
  • write_comments
  • read_contributors
  • write_contributors
  • delete_contributors
  • read_team_users
  • write_team_users
  • read_team_groups
  • write_team_groups
  • read_team_orders
  • write_team_orders
  • read_payment_cards
  • write_payment_cards
  • read_team_user_billing_details
  • write_team_user_billing_details
  • read_screenshots
  • write_screenshots
  • read_snapshots
  • write_snapshots
  • read_glossary
  • write_glossary
  • read_custom_translation_statuses
  • write_custom_translation_statuses
  • read_webhooks
  • write_webhooks
  • read_background_processes
  1. Log in to your WEXTL account, add the Lokalise node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Lokalise account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant project events from Lokalise.
Output fields[3]
FieldType
Eventtext
Projectobject
IDtext
Nametext
Branchtext
Userobject
Emailtext
Full Nametext
Created Attext

Get a Branch

SearchOne branch with its creator and creation time.
Input fields[3]
FieldType
Project IDRequired
choice
Branch IDRequired
choice
Output fields[3]
FieldType
Branch IDnumber
Nametext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

Get a Card

SearchShows the brand and last four digits of a card.
Input fields[3]
FieldType
Card IDRequired
choice
Output fields[3]
FieldType
Card IDnumber
Last4text
Brandtext
Created Attext
Created At Timestampnumber

Get a Comment

SearchSingle key comment with its author and time.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Comment IDRequired
text
Branchchoice
Output fields[3]
FieldType
Comment IDnumber
Key IDnumber
Commenttext
Added Bynumber
Added By Emailtext
Added Attext
Added At Timestampnumber

Get a Contributor

SearchOne contributor and what they are allowed to do.
Input fields[3]
FieldType
Project IDRequired
choice
Contributor IDRequired
choice
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Is Adminboolean
Is Reviewerboolean
Role IDnumber
Languagesarray
Languageobject
Admin Rightsarray

Get a Contributor Deletion Job

SearchProgress of a bulk contributor removal.
Input fields[3]
FieldType
Project IDRequired
choice
Job IDRequired
text
Output fields[3]
FieldType
Statetext
Project IDtext
Created Atnumber
Updated Atnumber
Totalnumber
Processednumber
Deletednumber
Failednumber
Skippednumber
Errorstext

Get a Glossary Term

SearchOne glossary entry in full with rules and translations.
Input fields[3]
FieldType
Project IDRequired
choice
Term IDRequired
choice
Output fields[3]
FieldType
IDnumber
Termtext
Descriptiontext
Case Sensitiveboolean
Translatableboolean
Forbiddenboolean
Translationsarray
Translationobject
Tagsarray
Project IDtext
Created Attext

1other output field

Get a Group

SearchOne user group and its permissions.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Get a Key

SearchOne key with platforms and filenames.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Branchchoice
Disable Referenceschoice
Include Ai Scoringchoice
Output fields[3]
FieldType
Key IDnumber
Created Attext
Created At Timestampnumber
Key Nameobject
Iostext
Androidtext
Webtext
Othertext
Filenamesobject
Iostext
Androidtext
Webtext
Othertext
Descriptiontext
Platformsarray
Tagsarray
Commentsarray
Commentobject
Screenshotsarray
Screenshotobject

13other output fields

Get a Key Language Segment

SearchText of a single translation segment.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Language ISO CodeRequired
choice
Segment NumberRequired
text
Disable Referenceschoice
Output fields[3]
FieldType
Segment Numbernumber
Language Isotext
Modified Attext
Modified At Timestampnumber
Modified Bynumber
Modified By Emailtext
Valuetext
Is Fuzzyboolean
Is Reviewedboolean
Reviewed Bynumber

2other output fields

Get a Language

SearchLanguage settings with plural rules.
Input fields[3]
FieldType
Project IDRequired
choice
Lang IDRequired
choice
Branchchoice
Output fields[3]
FieldType
Lang IDnumber
Lang Isotext
Lang Nametext
Is Rtlboolean
Plural Formsarray
CC Isotext

Get a Process

SearchProgress of a queued background job.
Input fields[3]
FieldType
Project IDRequired
choice
Process IDRequired
text
Branchchoice
Output fields[3]
FieldType
Process IDtext
Typetext
Statustext
Messagetext
Created Bynumber
Created By Emailtext
Created Attext
Created At Timestampnumber

Get a Project

SearchOne project and its general settings.
Input fields[3]
FieldType
Project IDRequired
choice
Output fields[3]
FieldType
Project IDtext
Project Typetext
Nametext
Descriptiontext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext
Team IDnumber
Base Language IDnumber

3other output fields

Get a Screenshot

SearchOne context image and its linked keys.
Input fields[3]
FieldType
Project IDRequired
choice
Screenshot IDRequired
choice
Output fields[3]
FieldType
Screenshot IDnumber
Key IDsarray
Keysarray
Keyobject
URLtext
Titletext
Descriptiontext
Screenshot Tagsarray
Widthnumber
Heightnumber
Created Attext

1other output field

Get a Task

SearchOne task and how far it has got.
Input fields[3]
FieldType
Project IDRequired
choice
Task IDRequired
choice
Branchchoice
Output fields[3]
FieldType
Task IDnumber
Titletext
Descriptiontext
Statustext
Progressnumber
Due Datetext
Due Date Timestampnumber
Keys Countnumber
Words Countnumber
Created Attext

20other output fields

Get a Team

SearchSubscription and your membership level in a team.
Input fields[3]
FieldType
Team IDRequired
choice
Output fields[3]
FieldType
Team IDnumber
Nametext
Created Attext
Created At Timestampnumber
Plantext
Logo URLtext
Roletext
Quota Usageobject
Usersnumber
Keysnumber
Projectsnumber
Maunumber
Traffic Bytesnumber
Ai Wordsnumber
Quota Allowedobject
Usersnumber
Keysnumber
Projectsnumber
Maunumber
Traffic Bytesnumber
Ai Wordsnumber
Is Team Suspendedboolean

2other output fields

Get a Team User

SearchContact and role of one member.
Input fields[3]
FieldType
Team IDRequired
choice
User IDRequired
choice
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Roletext

Get a Translation

SearchText of a translation with review data.
Input fields[3]
FieldType
Project IDRequired
choice
Translation IDRequired
text
Branchchoice
Disable Referenceschoice
Include Ai Scoringchoice
Output fields[3]
FieldType
Translation IDnumber
Key IDnumber
Language Isotext
Modified Attext
Modified At Timestampnumber
Modified Bynumber
Modified By Emailtext
Translationtext
Is Unverifiedboolean
Is Reviewedboolean

6other output fields

Get a Translation Provider

SearchProfessional vendor with price tiers.
Input fields[3]
FieldType
Team IDRequired
choice
Provider IDRequired
choice
Output fields[3]
FieldType
Provider IDnumber
Namenumber
Slugtext
Price Pair Minnumber
Website URLtext
Descriptiontext
Tiersobject
Tier IDnumber
Nametext
Pairsobject
Tier IDnumber
From Lang Isotext
From Lang Nametext
To Lang Isotext
To Lang Nametext
Price Per Wordnumber

Get a Translation Status

SearchName and color of a custom status.
Input fields[3]
FieldType
Project IDRequired
choice
Status IDRequired
choice
Output fields[3]
FieldType
Status IDnumber
Titletext
Colortext

Get a User

SearchAccount details for one Lokalise user.
Input fields[3]
FieldType
User IDRequired
choice
Output fields[3]
FieldType
IDnumber
UUIDtext
Emailtext
Fullnametext

Get a Webhook

SearchDelivery target and events of a webhook.
Input fields[3]
FieldType
Project IDRequired
choice
Webhook IDRequired
choice
Output fields[3]
FieldType
Webhook IDtext
URLtext
Branchtext
Secrettext
Eventsarray
Event Lang Maparray
Event Lang Mapobject

Get an Order

SearchStatus and payment of an order.
Input fields[3]
FieldType
Team IDRequired
choice
Order IDRequired
text
Output fields[3]
FieldType
Order IDtext
Project IDtext
Branchtext
Payment Methodtext
Card IDnumber
Statustext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

11other output fields

Get Billing Details

SearchSaved invoice contact and address of a team.
Input fields[3]
FieldType
Team IDRequired
choice
Output fields[3]
FieldType
Billing Emailtext
Country Codetext
Ziptext
State Codetext
Address1text
Address2text
Citytext
Phonetext
Companytext
Vatnumbertext

Get Task Usage Metrics

SearchWords handled in a single task.
Input fields[3]
FieldType
Project IDRequired
choice
Task IDRequired
choice
Branchchoice
Output fields[3]
FieldType
Processed Wordsnumber

Get the Current Contributor

SearchYour own record in a project.
Input fields[3]
FieldType
Project IDRequired
choice
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Is Adminboolean
Is Reviewerboolean
Role IDnumber
Languagesarray
Languageobject
Admin Rightsarray

List Audit Logs

SearchTeam activity log with filters.
Input fields[3]
FieldType
LimitRequired
number
Sortchoice
Date Fromdate
Date Todate
Event Typechoice
Projectchoice
User IDtext

List Branches

SearchEvery branch in a project.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Branch IDnumber
Nametext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

List Cards

SearchCards saved for team billing.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Card IDnumber
Last4text
Brandtext
Created Attext
Created At Timestampnumber

List Contributors

SearchContributors of one project with their rights.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Is Adminboolean
Is Reviewerboolean
Role IDnumber
Languagesarray
Languageobject
Admin Rightsarray

List Files

SearchUploaded files and how many keys each holds.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Filter Filenametext
Output fields[3]
FieldType
File IDnumber
Filenametext
Key Countnumber

List Glossary Terms

SearchGlossary entries with their translations.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Termtext
Descriptiontext
Case Sensitiveboolean
Translatableboolean
Forbiddenboolean
Translationsarray
Translationobject
Tagsarray
Project IDtext
Created Attext

1other output field

List Groups

SearchUser groups available in a team.
Input fields[3]
FieldType
Team IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

List Key Comments

SearchReads every note left on one key.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
LimitRequired
number
Branchchoice
Output fields[3]
FieldType
Comment IDnumber
Key IDnumber
Commenttext
Added Bynumber
Added By Emailtext
Added Attext
Added At Timestampnumber

List Key Language Segments

SearchPer-language segments of a translation.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Language ISO CodeRequired
choice
Disable Referenceschoice
Filter Is Reviewedchoice
Filter Unverifiedchoice
Filter Untranslatedchoice
Filter Qa Issuestext
Output fields[3]
FieldType
Segment Numbernumber
Language Isotext
Modified Attext
Modified At Timestampnumber
Modified Bynumber
Modified By Emailtext
Valuetext
Is Fuzzyboolean
Is Reviewedboolean
Reviewed Bynumber

2other output fields

List Keys

SearchKeys with optional translations and comments.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Disable Referenceschoice
Include Commentschoice
Include Screenshotschoice
Include Translationschoice
Include Ai Scoringchoice
Filter Translation Lang IDstext
Filter Tagstext

7other input fields

Output fields[3]
FieldType
Key IDnumber
Created Attext
Created At Timestampnumber
Key Nameobject
Iostext
Androidtext
Webtext
Othertext
Filenamesobject
Iostext
Androidtext
Webtext
Othertext
Descriptiontext
Platformsarray
Tagsarray
Commentsarray
Commentobject
Screenshotsarray
Screenshotobject

13other output fields

List Orders

SearchProfessional translation orders placed so far.
Input fields[3]
FieldType
Team IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Order IDtext
Project IDtext
Branchtext
Payment Methodtext
Card IDnumber
Statustext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

11other output fields

List Processes

SearchQueued and finished jobs in a project.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Output fields[3]
FieldType
Process IDtext
Typetext
Statustext
Messagetext
Created Bynumber
Created By Emailtext
Created Attext
Created At Timestampnumber

List Project Comments

SearchAll key comments gathered project wide.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Output fields[3]
FieldType
Comment IDnumber
Key IDnumber
Commenttext
Added Bynumber
Added By Emailtext
Added Attext
Added At Timestampnumber

List Project Languages

SearchConfigured languages with plural rules.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Output fields[3]
FieldType
Lang IDnumber
Lang Isotext
Lang Nametext
Is Rtlboolean
Plural Formsarray
CC Isotext

List Projects

SearchProjects with optional statistics and settings.
Input fields[3]
FieldType
LimitRequired
number
Teamchoice
Filter Namestext
Include Statisticschoice
Include Settingschoice
Sortchoice
Output fields[3]
FieldType
Project IDtext
Project Typetext
Nametext
Descriptiontext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext
Team IDnumber
Base Language IDnumber

3other output fields

List Screenshots

SearchContext images attached to keys.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Screenshot IDnumber
Key IDsarray
Keysarray
Keyobject
URLtext
Titletext
Descriptiontext
Screenshot Tagsarray
Widthnumber
Heightnumber
Created Attext

1other output field

List Snapshots

SearchPoint-in-time copies available to restore.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Snapshot IDnumber
Titletext
Created Attext
Created At Timestamptext
Created Bynumber
Created By Emailtext

List Status Colors

SearchColor palette for custom statuses.
Input fields[3]
FieldType
Project IDRequired
choice
Output fields[3]
FieldType
0text
1text
2text
3text
4text
5text

List System Languages

SearchFull catalog of supported languages.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Lang IDnumber
Lang Isotext
Lang Nametext
Is Rtlboolean
Plural Formsarray
CC Isotext

List Tasks

SearchProject tasks with deadlines and progress.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Filter Titletext
Filter Statusestext
Output fields[3]
FieldType
Task IDnumber
Titletext
Descriptiontext
Statustext
Progressnumber
Due Datetext
Due Date Timestampnumber
Keys Countnumber
Words Countnumber
Created Attext

18other output fields

List Team Roles

SearchRoles that team members can hold.
Input fields[3]
FieldType
Team IDRequired
choice
Output fields[3]
FieldType
IDnumber
Roletext
Permissionsarray
Descriptiontext
Tagtext
Tag Colortext
Tag Infotext
Does Enable All Read Only Languagesboolean

List Team Users

SearchEverybody on a team with their roles.
Input fields[3]
FieldType
Team IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Roletext

List Teams

SearchWorkspaces you are part of.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Team IDnumber
Nametext
Created Attext
Created At Timestampnumber
Plantext
Logo URLtext
Roletext
Quota Usageobject
Usersnumber
Keysnumber
Projectsnumber
Maunumber
Traffic Bytesnumber
Ai Wordsnumber
Quota Allowedobject
Usersnumber
Keysnumber
Projectsnumber
Maunumber
Traffic Bytesnumber
Ai Wordsnumber

List Translation Memories

SearchReusable memories attached to a project.
Input fields[3]
FieldType
Project IDRequired
choice
Output fields[3]
FieldType
IDnumber
UUIDtext
Nametext

List Translation Providers

SearchVendors you can order translations from.
Input fields[3]
FieldType
Team IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Provider IDnumber
Namenumber
Slugtext
Price Pair Minnumber
Website URLtext
Descriptiontext
Tiersobject
Tier IDnumber
Nametext
Pairsobject
Tier IDnumber
From Lang Isotext
From Lang Nametext
To Lang Isotext
To Lang Nametext
Price Per Wordnumber

List Translation Statuses

SearchCustom status labels defined for translations.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Status IDnumber
Titletext
Colortext

List Translations

SearchTranslations narrowed by review state.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Branchchoice
Disable Referenceschoice
Include Ai Scoringchoice
Filter Lang IDtext
Filter Is Reviewedchoice
Filter Unverifiedchoice
Filter Untranslatedchoice
Filter Qa Issuestext

1other input field

Output fields[3]
FieldType
Translation IDnumber
Key IDnumber
Language Isotext
Modified Attext
Modified At Timestampnumber
Modified Bynumber
Modified By Emailtext
Translationtext
Is Unverifiedboolean
Is Reviewedboolean

6other output fields

List Webhooks

SearchEvent hooks set up on a project.
Input fields[3]
FieldType
Project IDRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Webhook IDtext
URLtext
Branchtext
Secrettext
Eventsarray
Event Lang Maparray
Event Lang Mapobject

Add Members to a Group

ActionPuts users into a team group.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
UsersRequired
choice
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Add Projects to a Group

ActionAttaches projects to a team group.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
ProjectsRequired
choice
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Create a Branch

ActionStarts a branch for working on keys apart.
Input fields[3]
FieldType
Project IDRequired
choice
Nametext
Output fields[3]
FieldType
Branch IDnumber
Nametext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

Create a Group

ActionNew user group with permissions.
Input fields[3]
FieldType
Team IDRequired
choice
NameRequired
text
Is ReviewerRequired
boolean
Is AdminRequired
boolean
Role IDchoice
Admin Rightschoice
Languages Referencetext
Languages Contributabletext
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Create a Project

ActionFresh project in your team.
Input fields[3]
FieldType
NameRequired
text
Team IDchoice
Descriptiontext
Languagesarray
Languageobject
Base Langchoice
Project Typechoice
Content Integrationtext
Is Segmentation Enabledboolean
Output fields[3]
FieldType
Project IDtext
Project Typetext
Nametext
Descriptiontext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext
Team IDnumber
Base Language IDnumber

3other output fields

Create a Service Token

ActionToken for over-the-air updates.
Input fields[3]
FieldType
Project IDRequired
choice
ServiceRequired
choice
Output fields[3]
FieldType
Jwttext

Create a Snapshot

ActionPoint-in-time copy of a project.
Input fields[3]
FieldType
Project IDRequired
choice
Titletext
Output fields[3]
FieldType
Snapshot IDnumber
Titletext
Created Attext
Created At Timestamptext
Created Bynumber
Created By Emailtext

Create a Task

ActionNew task with languages and a deadline.
Input fields[3]
FieldType
Project IDRequired
choice
TitleRequired
text
Branchchoice
Descriptiontext
Due Datedate
Keystext
Languagesarray
Languageobject
Source Languagechoice
Auto Close Languagesboolean
Auto Close Taskboolean

12other input fields

Output fields[3]
FieldType
Task IDnumber
Titletext
Descriptiontext
Statustext
Progressnumber
Due Datetext
Due Date Timestampnumber
Keys Countnumber
Words Countnumber
Created Attext

18other output fields

Create a Translation Status

ActionCustom status label for translations.
Input fields[3]
FieldType
Project IDRequired
choice
TitleRequired
text
ColorRequired
text
Output fields[3]
FieldType
Status IDnumber
Titletext
Colortext

Create a Webhook

ActionSends project events to your URL.
Input fields[3]
FieldType
Project IDRequired
choice
URLRequired
text
EventsRequired
choice
Branchchoice
Event Lang Maparray
Event Lang Mapobject
Output fields[3]
FieldType
Webhook IDtext
URLtext
Branchtext
Secrettext
Eventsarray
Event Lang Maparray
Event Lang Mapobject

Create an Order

ActionProfessional translation order with optional dry run quote.
Input fields[3]
FieldType
Team IDRequired
choice
Project IDRequired
choice
BriefingRequired
text
Source LanguageRequired
choice
Target Language ISO CodesRequired
choice
KeysRequired
text
Provider SlugRequired
text
Translation TierRequired
number
Branchchoice
Payment Methodchoice

4other input fields

Output fields[3]
FieldType
Order IDtext
Project IDtext
Branchtext
Payment Methodtext
Card IDnumber
Statustext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

11other output fields

Create Billing Details

ActionInvoice details for a team.
Input fields[3]
FieldType
Team IDRequired
choice
Billing EmailRequired
text
Country CodeRequired
text
ZipRequired
text
State Codetext
Address1text
Address2text
Citytext
Phonetext
Companytext

1other input field

Output fields[3]
FieldType
Billing Emailtext
Country Codetext
Ziptext
State Codetext
Address1text
Address2text
Citytext
Phonetext
Companytext
Vatnumbertext

Create Contributors

ActionAdds people to a project team.
Input fields[3]
FieldType
Project IDRequired
choice
ContributorsRequired
array
Contributorobject
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Is Adminboolean
Is Reviewerboolean
Role IDnumber
Languagesarray
Languageobject
Admin Rightsarray

Create Glossary Terms

ActionGlossary entries for a project.
Input fields[3]
FieldType
Project IDRequired
choice
TermsRequired
array
Termobject
Output fields[3]
FieldType
IDnumber
Termtext
Descriptiontext
Case Sensitiveboolean
Translatableboolean
Forbiddenboolean
Translationsarray
Translationobject
Tagsarray
Project IDtext
Created Attext

1other output field

Create Key Comments

ActionAdds comments to a translation key.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
CommentsRequired
array
Commentobject
Branchchoice
Output fields[3]
FieldType
Comment IDnumber
Key IDnumber
Commenttext
Added Bynumber
Added By Emailtext
Added Attext
Added At Timestampnumber

Create Keys

ActionBulk creation of translation keys.
Input fields[3]
FieldType
Project IDRequired
choice
KeysRequired
array
Keyobject
Branchchoice
Use Automationschoice
Output fields[3]
FieldType
Key IDnumber
Created Attext
Created At Timestampnumber
Key Nameobject
Iostext
Androidtext
Webtext
Othertext
Filenamesobject
Iostext
Androidtext
Webtext
Othertext
Descriptiontext
Platformsarray
Tagsarray
Commentsarray
Commentobject
Screenshotsarray
Screenshotobject

13other output fields

Create Languages

ActionExtra target languages for translation.
Input fields[3]
FieldType
Project IDRequired
choice
LanguagesRequired
array
Languageobject
Branchchoice
Output fields[3]
FieldType
Lang IDnumber
Lang Isotext
Lang Nametext
Is Rtlboolean
Plural Formsarray
CC Isotext

Create Screenshots

ActionContext images for keys.
Input fields[3]
FieldType
Project IDRequired
choice
ScreenshotsRequired
array
Screenshotobject
Output fields[3]
FieldType
Screenshot IDnumber
Key IDsarray
Keysarray
Keyobject
URLtext
Titletext
Descriptiontext
Screenshot Tagsarray
Widthnumber
Heightnumber
Created Attext

1other output field

Delete a Branch

ActionRemoves a project branch and reports its Branch ID.
Input fields[3]
FieldType
Project IDRequired
choice
Branch IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Branch IDtext

Delete a Card

ActionClears a saved card from billing.
Input fields[3]
FieldType
Card IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Card IDtext

Delete a Comment

ActionClears a single key note.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Comment IDRequired
text
Branchchoice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Key IDtext
Comment IDtext

Delete a Contributor

ActionRemoves one person from the project team.
Input fields[3]
FieldType
Project IDRequired
choice
Contributor IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Contributor IDtext

Delete a File

ActionDeletes an imported translation file.
Input fields[3]
FieldType
Project IDRequired
choice
File IDRequired
choice
Branchchoice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
File IDtext

Delete a Group

ActionDeletes a team permission group.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Team IDtext
Group IDtext

Delete a Key

ActionRemoves one string from a project.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Branchchoice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Key IDtext

Delete a Language

ActionStops translating into a language.
Input fields[3]
FieldType
Project IDRequired
choice
Lang IDRequired
choice
Branchchoice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Lang IDtext

Delete a Project

ActionDeletes a project you no longer need.
Input fields[3]
FieldType
Project IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext

Delete a Screenshot

ActionRemoves a context image.
Input fields[3]
FieldType
Project IDRequired
choice
Screenshot IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Screenshot IDtext

Delete a Snapshot

ActionDeletes a stored project state.
Input fields[3]
FieldType
Project IDRequired
choice
Snapshot IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Snapshot IDtext

Delete a Task

ActionDeletes one translation task by ID.
Input fields[3]
FieldType
Project IDRequired
choice
Task IDRequired
choice
Branchchoice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Task IDtext

Delete a Team User

ActionEnds a user membership in a team.
Input fields[3]
FieldType
Team IDRequired
choice
User IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Team IDtext
User IDtext

Delete a Translation Status

ActionRemoves a custom status label.
Input fields[3]
FieldType
Project IDRequired
choice
Status IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Status IDtext

Delete a Webhook

ActionStops a webhook from firing.
Input fields[3]
FieldType
Project IDRequired
choice
Webhook IDRequired
choice
Output fields[3]
FieldType
Deletedboolean
Project IDtext
Webhook IDtext

Delete All Contributors

ActionBulk removal job for contributors.
Input fields[3]
FieldType
Project IDRequired
choice
ConfirmRequired
text
Output fields[3]
FieldType
Job IDtext

Delete Glossary Terms

ActionDeletes glossary entries by ID.
Input fields[3]
FieldType
Project IDRequired
choice
TermsRequired
text
Output fields[3]
FieldType
Dataobject
Deletedobject
Failedobject

Delete Multiple Keys

ActionBulk key deletion with counts.
Input fields[3]
FieldType
Project IDRequired
choice
KeysRequired
text
Branchchoice
Output fields[3]
FieldType
Project IDtext
Keys Removedboolean
Keys Lockednumber

Delete Project Content

ActionEmpties a project of its keys.
Input fields[3]
FieldType
Project IDRequired
choice
ConfirmRequired
text
Branchchoice
Output fields[3]
FieldType
Project IDtext
Keys Deletedboolean

Download Files

ActionExports a translation bundle.
Input fields[3]
FieldType
Project IDRequired
choice
FormatRequired
text
Branchchoice
Original Filenameschoice
Bundle Structuretext
Directory Prefixtext
All Platformschoice
Filter Langschoice
Filter Datachoice
Filter Filenamestext

28other input fields

Output fields[3]
FieldType
Project IDtext
Bundle URLtext

Download Files Async

ActionBackground export of translations.
Input fields[3]
FieldType
Project IDRequired
choice
FormatRequired
text
Branchchoice
Original Filenameschoice
Bundle Structuretext
Directory Prefixtext
All Platformschoice
Filter Langschoice
Filter Datachoice
Filter Filenamestext

28other input fields

Output fields[3]
FieldType
Process IDtext

Import Contributors

ActionCopies people between projects.
Input fields[3]
FieldType
Project IDRequired
choice
From Project UUIDRequired
text
Contributor IDstext
Output fields[3]
FieldType
IDtext
Successboolean
Reasontext

Make an API Call

universalDirect Lokalise REST API access for uncovered endpoints.
Input fields[3]
FieldType
PathRequired
text
MethodRequired
choice
APIchoice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Merge a Branch

ActionBrings branch changes into another branch.
Input fields[3]
FieldType
Project IDRequired
choice
Branch IDRequired
choice
Force Conflict Resolve Usingchoice
Target Branch IDtext
Output fields[3]
FieldType
Project IDtext
Branch Mergedboolean
Branchobject
Branch IDnumber
Nametext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext
Target Branchobject
Branch IDnumber
Nametext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

Regenerate a Webhook Secret

ActionRotates the signing secret for a hook.
Input fields[3]
FieldType
Project IDRequired
choice
Webhook IDRequired
choice
Output fields[3]
FieldType
Project IDtext
Secrettext

Remove Members from a Group

ActionStrips users out of a group.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
UsersRequired
choice
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Remove Projects from a Group

ActionStops a group from reaching projects.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
ProjectsRequired
choice
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Restore a Snapshot

ActionNew project rebuilt from a snapshot.
Input fields[3]
FieldType
Project IDRequired
choice
Snapshot IDRequired
choice
Output fields[3]
FieldType
Project IDtext
Project Typetext
Nametext
Descriptiontext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext
Team IDnumber
Base Language IDnumber

3other output fields

Update a Branch

ActionRelabels a branch inside a project.
Input fields[3]
FieldType
Project IDRequired
choice
Branch IDRequired
choice
Nametext
Clear Fieldschoice
Output fields[3]
FieldType
Branch IDnumber
Nametext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext

Update a Contributor

ActionEdits what a contributor may do.
Input fields[3]
FieldType
Project IDRequired
choice
Contributor IDRequired
choice
Is Adminchoice
Is Reviewerchoice
Role IDchoice
Languagesarray
Languageobject
Admin Rightschoice
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Is Adminboolean
Is Reviewerboolean
Role IDnumber
Languagesarray
Languageobject
Admin Rightsarray

Update a Group

ActionEdits permissions of a group.
Input fields[3]
FieldType
Team IDRequired
choice
Group IDRequired
choice
Nametext
Is Reviewerchoice
Is Adminchoice
Role IDchoice
Admin Rightschoice
Languages Referencetext
Languages Contributabletext
Output fields[3]
FieldType
Group IDnumber
Nametext
Permissionsobject
Is Adminboolean
Is Reviewerboolean
Admin Rightsarray
Languagesarray
Created Attext
Created At Timestampnumber
Team IDnumber
Projectsarray
Membersarray
Role IDnumber

Update a Key

ActionEdits the details of a translation key.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Branchchoice
Key Nametext
Descriptiontext
Platformschoice
Filenames Iostext
Filenames Androidtext
Filenames Webtext
Filenames Othertext

10other input fields

Output fields[3]
FieldType
Key IDnumber
Created Attext
Created At Timestampnumber
Key Nameobject
Iostext
Androidtext
Webtext
Othertext
Filenamesobject
Iostext
Androidtext
Webtext
Othertext
Descriptiontext
Platformsarray
Tagsarray
Commentsarray
Commentobject
Screenshotsarray
Screenshotobject

13other output fields

Update a Key Language Segment

ActionEdits a segment of a translation.
Input fields[3]
FieldType
Project IDRequired
choice
Key IDRequired
text
Language ISO CodeRequired
choice
Segment NumberRequired
text
Valuetext
Is Fuzzychoice
Is Reviewedchoice
Custom Translation Status IDstext
Clear Fieldschoice
Output fields[3]
FieldType
Segment Numbernumber
Language Isotext
Modified Attext
Modified At Timestampnumber
Modified Bynumber
Modified By Emailtext
Valuetext
Is Fuzzyboolean
Is Reviewedboolean
Reviewed Bynumber

2other output fields

Update a Language

ActionEdits ISO code, label or plural rules of a language.
Input fields[3]
FieldType
Project IDRequired
choice
Lang IDRequired
choice
Branchchoice
Language ISO Codetext
Lang Nametext
Plural Formstext
Clear Fieldschoice
Output fields[3]
FieldType
Lang IDnumber
Lang Isotext
Lang Nametext
Is Rtlboolean
Plural Formsarray
CC Isotext

Update a Project

ActionEdits project name and summary.
Input fields[3]
FieldType
Project IDRequired
choice
Nametext
Descriptiontext
Clear Fieldschoice
Output fields[3]
FieldType
Project IDtext
Project Typetext
Nametext
Descriptiontext
Created Attext
Created At Timestampnumber
Created Bynumber
Created By Emailtext
Team IDnumber
Base Language IDnumber

3other output fields

Update a Screenshot

ActionEdits screenshot details and key links.
Input fields[3]
FieldType
Project IDRequired
choice
Screenshot IDRequired
choice
Branchchoice
Titletext
Descriptiontext
Key IDstext
Tagstext
Clear Fieldschoice
Output fields[3]
FieldType
Screenshot IDnumber
Key IDsarray
Keysarray
Keyobject
URLtext
Titletext
Descriptiontext
Screenshot Tagsarray
Widthnumber
Heightnumber
Created Attext

1other output field

Update a Task

ActionEdits task deadline and scope.
Input fields[3]
FieldType
Project IDRequired
choice
Task IDRequired
choice
Branchchoice
Titletext
Descriptiontext
Due Datedate
Languagesarray
Languageobject
Auto Close Languageschoice
Auto Close Taskchoice
Auto Close Itemschoice

4other input fields

Output fields[3]
FieldType
Task IDnumber
Titletext
Descriptiontext
Statustext
Progressnumber
Due Datetext
Due Date Timestampnumber
Keys Countnumber
Words Countnumber
Created Attext

18other output fields

Update a Team User

ActionEdits the permission level of a member.
Input fields[3]
FieldType
Team IDRequired
choice
User IDRequired
choice
Roletext
Clear Fieldschoice
Output fields[3]
FieldType
User IDnumber
Emailtext
Fullnametext
Created Attext
Created At Timestampnumber
Roletext

Update a Translation

ActionEdits text and review flags of a translation.
Input fields[3]
FieldType
Project IDRequired
choice
Translation IDRequired
text
Branchchoice
Translationtext
Is Unverifiedchoice
Is Reviewedchoice
Custom Translation Status IDstext
Output fields[3]
FieldType
Translation IDnumber
Key IDnumber
Language Isotext
Modified Attext
Modified At Timestampnumber
Modified Bynumber
Modified By Emailtext
Translationtext
Is Unverifiedboolean
Is Reviewedboolean

6other output fields

Update a Translation Status

ActionRelabels and recolors a status.
Input fields[3]
FieldType
Project IDRequired
choice
Status IDRequired
choice
Titletext
Colortext
Clear Fieldschoice
Output fields[3]
FieldType
Status IDnumber
Titletext
Colortext

Update a Webhook

ActionEdits delivery target and events of a webhook.
Input fields[3]
FieldType
Project IDRequired
choice
Webhook IDRequired
choice
URLtext
Branchchoice
Eventschoice
Event Lang Maparray
Event Lang Mapobject
Clear Fieldschoice
Output fields[3]
FieldType
Webhook IDtext
URLtext
Branchtext
Secrettext
Eventsarray
Event Lang Maparray
Event Lang Mapobject

Update Billing Details

ActionEdits invoice contact and address.
Input fields[3]
FieldType
Team IDRequired
choice
Billing Emailtext
Country Codetext
Ziptext
State Codetext
Address1text
Address2text
Citytext
Phonetext
Companytext

2other input fields

Output fields[3]
FieldType
Billing Emailtext
Country Codetext
Ziptext
State Codetext
Address1text
Address2text
Citytext
Phonetext
Companytext
Vatnumbertext

Update Glossary Terms

ActionBulk edit of glossary entries.
Input fields[3]
FieldType
Project IDRequired
choice
TermsRequired
array
Termobject
Output fields[3]
FieldType
IDnumber
Termtext
Descriptiontext
Case Sensitiveboolean
Translatableboolean
Forbiddenboolean
Translationsarray
Translationobject
Tagsarray
Project IDtext
Created Attext

1other output field

Update Multiple Keys

ActionBulk edits across keys.
Input fields[3]
FieldType
Project IDRequired
choice
KeysRequired
array
Keyobject
Branchchoice
Use Automationschoice
Output fields[3]
FieldType
Key IDnumber
Created Attext
Created At Timestampnumber
Key Nameobject
Iostext
Androidtext
Webtext
Othertext
Filenamesobject
Iostext
Androidtext
Webtext
Othertext
Descriptiontext
Platformsarray
Tagsarray
Commentsarray
Commentobject
Screenshotsarray
Screenshotobject

13other output fields

Upload a File

ActionImports a translation file and starts a process.
Input fields[3]
FieldType
Project IDRequired
choice
FilenameRequired
text
LangRequired
choice
Contenttext
Base64 Datatext
Branchchoice
Convert Placeholderschoice
Detect Icu Pluralschoice
Tagstext
Tag Inserted Keyschoice

21other input fields

Output fields[3]
FieldType
Process IDtext
Typetext
Statustext
Messagetext
Created Bynumber
Created By Emailtext
Created Attext
Created At Timestampnumber

Look for Lokalise templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Lokalise Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Lokalise.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.