reference

Webhook payloads

26 requests wxrks sends as a POST with a JSON body to a webhook's URL

To create and manage webhooks, see the Webhooks endpoints.

Every request

header parameters

X-BWX-Event-IDalways sent string (uuid)
The event's id. Automatic and manual retries keep it, except a manual retry of a delivery logged before event ids were stored, which gets a new one. Store the ids you have handled and ignore one you have already seen.
X-BWX-Webhook-IDalways sent string (uuid)
The id of the webhook.
X-BWX-Event-Typealways sent string
The event type, such as WORK_UNIT_CREATED, or WEBHOOK_VALIDATION.
X-BWX-Timestamp string
When the request was signed, in Unix seconds. Only when the webhook has a secret; every attempt is signed again.
X-BWX-Signature string
v1= followed by the lowercase hex HMAC-SHA256 of {X-BWX-Timestamp}.{raw body}, keyed with the webhook's secret. Only when the webhook has a secret.
X-BWX-Webhook-Secretdeprecated string
The webhook's secret in plain text, when it has one. Kept for receivers written before signatures: check X-BWX-Signature instead.
X-BWX-Retry-Of string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery in List Webhook Events.
User-Agentalways sent string
Always wxrks.

Your answer

2XX Delivered. Any other answer, or none within 3 seconds, is a failed delivery.

Event types

NEW_EMPTY_PROJECT A project is created without files.
New Empty Project · 24 fields
NEW_ORG An organization is created.
New Organization · 10 fields
NEW_ORG_UNIT An org unit is created.
New Org. Unit · 79 fields
NEW_PROJECT A project is created with files, from the app, the API, continuous localization or work unit automation.
New Project · 24 fields
NEW_USER A user is created, from the app, single sign-on or SCIM provisioning.
New User · 35 fields
ORG_UNIT_UPDATE An org unit is updated.
Org. Unit Updated · 77 fields
ORG_UPDATE An organization is updated.
Organization Updated · 8 fields
PROJECT_INGESTION_COMPLETED Every file of a project was parsed, or failed to be.
Project Ingestion Completed · 9 fields
PROJECT_LOGFILE_COMPLETED A logfile (analysis) finishes: one created with Create Logfile or in the app, or one wxrks runs to calculate costs.
Project Logfile Completed · 13 fields
PROJECT_STATUS_CHANGE A project's status changes.
Project Status Changed · 26 fields
PROJECT_TRANSLATION_FINISHED An automatic translation of a project ends: every work unit of the run was translated, or failed to be.
Project Translation Finished · 11 fields
PROJECT_UPDATE A project is updated.
Project Updated · 24 fields
SEGMENT_COMMENT_CREATED A comment or a reply is added to a segment, in the editor or with Create Segment Comment.
Segment Comment Created · 14 fields
TASK_ASSIGNED A task is assigned.
Task Assigned · 34 fields
TASK_DUE_DATE_CHANGE A task's due date is changed or removed, on the task or in a bulk update.
Task Due Date Changed · 37 fields
TASK_OVERDUE A task that is ASSIGNED, PENDING_ACCEPTANCE or PENDING_CONFIRMATION passes its due date.
Task Overdue · 35 fields
TASK_STATUS_CHANGE A task's status changes.
Task Status Changed · 36 fields
TASK_UPDATE A task is updated.
Task Updated · 32 fields
TASK_VENDOR_RESPONSE The vendor accepts or declines a task pending their acceptance.
Task Vendor Response · 36 fields
TRANSLATION_KIT_JOB_FINISHED A translation kit job ends, with COMPLETED or FAILED: an export kit, translated files, source files, or a bulk import.
Translation Kit Job Finished · 14 fields
USER_UPDATE A user is updated.
User Updated · 36 fields
WEBHOOK_VALIDATION Sent when a webhook is created, and again when it is activated with Toggle Webhook.
Webhook Validation · 7 fields
WORK_UNIT_CREATED A work unit's file is parsed and the work unit is ready, once per workflow step.
Work Unit Created · 15 fields
WORK_UNIT_IMPORT_FINISHED An import of a bilingual file into a work unit ends, with IMPORTED or ERROR.
Work Unit Import Finished · 22 fields
WORK_UNIT_STATUS_CHANGE A work unit's status changes.
Work Unit Status Changed · 26 fields
WORK_UNIT_TRANSLATION_FILE_READY A work unit's translated file is built and can be downloaded.
Work Unit Translation File Ready · 20 fields

POSTNEW_EMPTY_PROJECT

New Empty Project

A project is created without files. Its target languages and workflows are usually still empty.

Body · 24 fields

NewEmptyProjectEvent

ci_tagalways sent string
Continuous-localization tag of the project.
costs_statusalways sent stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED
Where the cost calculation stands.
creation_timestampalways sent integer (int64)
When the project was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the project.
creator_emailalways sent string
E-mail of the person who created the project.
currencyalways sent string
Currency code of the project's costs.
custom_field_valuesalways sent object
The project's custom field values by key: the field name in lower case, with anything but letters and digits as _ (Contract value is contract_value). Renaming a field changes its key. Empty values, and fields whose keys collide, are left out.
custom_fieldsalways sent object
Custom field values of the project.
event_typealways sent stringNEW_EMPTY_PROJECT
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the project.
instructionsalways sent string
Instructions for the people working on the project.
namealways sent string
Code wxrks gives the project (B-…), shown under its title.
notesalways sent string
Internal notes.
org_unit_uuidalways sent string (uuid)
Org unit (client) the project belongs to.
referencealways sent string
Project title, shown as the heading of the project page.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_localealways sent string
Source language code.
statusalways sent stringDeleted Cancelled Draft Pending Approved Delivered Invoiced Partially Invoiced Not Invoiced Continuous
Project status, as its display name.
tagsalways sent object[]
Project tags.
target_localesalways sent object[]
Target language codes.
total_costalways sent number
Total cost of the project in its currency, with 2 decimals. Empty until costs are calculated.
uuidalways sent string (uuid)
Unique id of the project.
workflowsalways sent object[]
Codes of the project's workflow steps.
Example body
{
  "ci_tag": "string",
  "costs_status": "CREATING",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "currency": "string",
  "custom_field_values": {},
  "custom_fields": {},
  "event_type": "NEW_EMPTY_PROJECT",
  "id": 0,
  "instructions": "string",
  "name": "string",
  "notes": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "status": "Deleted",
  "tags": [],
  "target_locales": [],
  "total_cost": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflows": []
}

POSTNEW_ORG

New Organization

An organization is created.

Body · 10 fields

NewOrgEvent

countryalways sent string
Country code.
creator_email string
E-mail of the signed-in user who created it; missing when created by the system.
creator_uuid string (uuid)
The signed-in user who created it; missing when created by the system.
custom_fieldsalways sent object
Custom field values of the organization.
event_typealways sent stringNEW_ORG
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the organization.
namealways sent string
Organization name.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
uuidalways sent string (uuid)
Unique id of the organization.
Example body
{
  "country": "string",
  "creator_email": "string",
  "creator_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "custom_fields": {},
  "event_type": "NEW_ORG",
  "id": 0,
  "name": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

POSTNEW_ORG_UNIT

New Org. Unit

An org unit is created.

Body · 79 fields

NewOrgUnitEvent

account_codealways sent string
Accounting code for revenue.
address_additional_info string
Additional address details.
address_city string
City of the address.
address_neighborhood string
Neighborhood of the address.
address_number string
Street number of the address.
address_state string
State of the address.
address_street string
Street of the address.
address_zip string
Postal code of the address.
auto_billingalways sent boolean
Whether billing is automatic.
autopilot_enabledalways sent boolean
Whether autopilot is on.
billing_emailalways sent string
E-mail for invoices.
categorization_disabledalways sent boolean
Whether categorization is off.
client_languagesalways sent string
Languages of the org unit.
confidence_match_over_repetition_enabledalways sent boolean
Whether confidence matches win over repetitions.
consolidate_projectsalways sent boolean
Whether projects are consolidated on invoices.
contact_notesalways sent string
Notes about how to contact the org unit.
contact_person_email_notificationsalways sent boolean
Whether the contact person gets e-mails.
continuous_platform_tagalways sent string
Tag for continuous localization.
continuous_project_configalways sent string
Settings of continuous projects.
costs_logfile_typealways sent string
Which analysis costs are calculated from.
countryalways sent string
Country code.
creator_email string
E-mail of the signed-in user who created it; missing when created by the system.
creator_uuid string (uuid)
The signed-in user who created it; missing when created by the system.
currencyalways sent string
Currency code.
custom_fieldsalways sent object
Custom field values of the org unit.
custom_receivable_by_useralways sent boolean
Whether receivables are customized per user.
days_until_payment_duealways sent integer (int64)
Days until an invoice is due.
default_contact_person_emailalways sent string
E-mail of the default contact person.
default_contact_person_namealways sent string
Name of the default contact person.
default_contact_person_uuidalways sent string (uuid)
Default contact person.
default_project_manager_emailalways sent string
E-mail of the default project manager.
default_project_manager_namealways sent string
Name of the default project manager.
default_project_manager_uuidalways sent string (uuid)
Default project manager.
default_source_languagealways sent string
Default source language code.
event_typealways sent stringNEW_ORG_UNIT
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the org unit.
invoice_grouping_keyalways sent string
How projects are grouped on invoices.
invoice_infoalways sent string
Text printed on invoices.
invoicing_typealways sent string
How often the org unit is invoiced.
isolated_tagsalways sent boolean
Whether the org unit's tags are kept apart.
locale_regionalways sent object
Language code to region.
mobilealways sent string
Mobile number.
namealways sent string
Org unit name.
notesalways sent string
Internal notes.
notify_project_commentsalways sent boolean
Whether project comments are notified.
notify_zendesk_enabledalways sent boolean
Whether Zendesk is notified.
nt_match_over_repetition_enabledalways sent boolean
Whether non-translatable matches win over repetitions.
override_default_regexalways sent boolean
Whether the regex replaces the default one.
payment_methodalways sent string
How the org unit pays.
phonealways sent string
Phone number.
project_automation_enabledalways sent boolean
Whether project automation is on.
project_count_words_fromalways sent string
Which count project words come from.
project_manager_email_notificationsalways sent boolean
Whether the project manager gets e-mails.
quote_notesalways sent object[]
Notes printed on quotes.
regexalways sent string
Custom segmentation or protection regex.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
send_available_tasks_emailalways sent boolean
Whether vendors get the available tasks e-mail.
send_invoice_to_requesteralways sent boolean
Whether invoices go to the requester.
send_quote_autoalways sent boolean
Whether quotes are sent automatically.
send_receivable_email_notificationalways sent boolean
Whether receivable e-mails are sent.
settingsalways sent object
Editor and branding settings of the org unit.
tagsalways sent object[]
Org unit tags.
task_count_words_fromalways sent string
Which count task words come from.
task_payment_typealways sent string
How tasks are paid.
tax_info_issue_nfe boolean
Brazilian tax setting: issue an electronic invoice.
tax_info_municipal_registration string
Municipal tax registration.
tax_info_require_purchase_order boolean
Whether a purchase order is required.
tax_info_retain_ir boolean
Brazilian tax setting: retain income tax.
tax_info_simples_nacional boolean
Brazilian tax setting: Simples Nacional.
taxpayer_idalways sent string
Tax identification number.
timezonealways sent string
Time zone of the org unit.
tm_match_over_repetition_enabledalways sent boolean
Whether TM matches win over repetitions.
tracking_categoryalways sent string
Accounting tracking category.
tracking_category_typealways sent string
Type of the accounting tracking category.
uuidalways sent string (uuid)
Unique id of the org unit.
vendor_email_notificationsalways sent boolean
Whether vendors get e-mails.
websitealways sent string
Website address.
xero_idalways sent string
Id of the org unit in Xero.
Example body
{
  "account_code": "string",
  "address_additional_info": "string",
  "address_city": "string",
  "address_neighborhood": "string",
  "address_number": "string",
  "address_state": "string",
  "address_street": "string",
  "address_zip": "string",
  "auto_billing": false,
  "autopilot_enabled": false,
  "billing_email": "string",
  "categorization_disabled": false,
  "client_languages": "string",
  "confidence_match_over_repetition_enabled": false,
  "consolidate_projects": false,
  "contact_notes": "string",
  "contact_person_email_notifications": false,
  "continuous_platform_tag": "string",
  "continuous_project_config": "string",
  "costs_logfile_type": "string",
  "country": "string",
  "creator_email": "string",
  "creator_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "string",
  "custom_fields": {},
  "custom_receivable_by_user": false,
  "days_until_payment_due": 0,
  "default_contact_person_email": "string",
  "default_contact_person_name": "string",
  "default_contact_person_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "default_project_manager_email": "string",
  "default_project_manager_name": "string",
  "default_project_manager_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "default_source_language": "string",
  "event_type": "NEW_ORG_UNIT",
  "id": 0,
  "invoice_grouping_key": "string",
  "invoice_info": "string",
  "invoicing_type": "string",
  "isolated_tags": false,
  "locale_region": {},
  "mobile": "string",
  "name": "string",
  "notes": "string",
  "notify_project_comments": false,
  "notify_zendesk_enabled": false,
  "nt_match_over_repetition_enabled": false,
  "override_default_regex": false,
  "payment_method": "string",
  "phone": "string",
  "project_automation_enabled": false,
  "project_count_words_from": "string",
  "project_manager_email_notifications": false,
  "quote_notes": [],
  "regex": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "send_available_tasks_email": false,
  "send_invoice_to_requester": false,
  "send_quote_auto": false,
  "send_receivable_email_notification": false,
  "settings": {},
  "tags": [],
  "task_count_words_from": "string",
  "task_payment_type": "string",
  "tax_info_issue_nfe": false,
  "tax_info_municipal_registration": "string",
  "tax_info_require_purchase_order": false,
  "tax_info_retain_ir": false,
  "tax_info_simples_nacional": false,
  "taxpayer_id": "string",
  "timezone": "string",
  "tm_match_over_repetition_enabled": false,
  "tracking_category": "string",
  "tracking_category_type": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendor_email_notifications": false,
  "website": "string",
  "xero_id": "string"
}

POSTNEW_PROJECT

New Project

A project is created with files, from the app, the API, continuous localization or work unit automation.

Body · 24 fields

NewProjectEvent

ci_tagalways sent string
Continuous-localization tag of the project.
costs_statusalways sent stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED
Where the cost calculation stands.
creation_timestampalways sent integer (int64)
When the project was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the project.
creator_emailalways sent string
E-mail of the person who created the project.
currencyalways sent string
Currency code of the project's costs.
custom_field_valuesalways sent object
The project's custom field values by key: the field name in lower case, with anything but letters and digits as _ (Contract value is contract_value). Renaming a field changes its key. Empty values, and fields whose keys collide, are left out.
custom_fieldsalways sent object
Custom field values of the project.
event_typealways sent stringNEW_PROJECT
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the project.
instructionsalways sent string
Instructions for the people working on the project.
namealways sent string
Code wxrks gives the project (B-…), shown under its title.
notesalways sent string
Internal notes.
org_unit_uuidalways sent string (uuid)
Org unit (client) the project belongs to.
referencealways sent string
Project title, shown as the heading of the project page.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_localealways sent string
Source language code.
statusalways sent stringDeleted Cancelled Draft Pending Approved Delivered Invoiced Partially Invoiced Not Invoiced Continuous
Project status, as its display name.
tagsalways sent object[]
Project tags.
target_localesalways sent object[]
Target language codes.
total_costalways sent number
Total cost of the project in its currency, with 2 decimals. Empty until costs are calculated.
uuidalways sent string (uuid)
Unique id of the project.
workflowsalways sent object[]
Codes of the project's workflow steps.
Example body
{
  "ci_tag": "string",
  "costs_status": "CREATING",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "currency": "string",
  "custom_field_values": {},
  "custom_fields": {},
  "event_type": "NEW_PROJECT",
  "id": 0,
  "instructions": "string",
  "name": "string",
  "notes": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "status": "Deleted",
  "tags": [],
  "target_locales": [],
  "total_cost": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflows": []
}

POSTNEW_USER

New User

A user is created, from the app, single sign-on or SCIM provisioning.

Body · 35 fields

NewUserEvent

addressalways sent string
Address line 1.
address2always sent string
Address line 2.
bioalways sent string
Short biography.
birth_datealways sent integer (int64)
Date of birth. Unix time in milliseconds.
cell_phonealways sent string
Mobile number.
cityalways sent string
City.
company_namealways sent string
Company name.
contract_signedalways sent boolean
Whether the user signed the contract.
countryalways sent string
Country code.
currencyalways sent string
Currency code.
custom_fieldsalways sent object
Custom field values of the user.
daily_ratealways sent number
Rate per day.
emailalways sent string
User e-mail.
event_typealways sent stringNEW_USER
The event's type key, repeated in the details.
hourly_ratealways sent number
Rate per hour.
idalways sent integer (int64)
Numeric id of the user.
minimum_feealways sent number
Minimum fee per task.
namealways sent string
User name.
notesalways sent string
Internal notes.
on_payoneeralways sent boolean
Whether the user is paid through Payoneer.
pages_ratealways sent number
Rate per page.
payment_methodalways sent string
How the user is paid.
phonealways sent string
Phone number.
postal_codealways sent string
Postal code.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
rolealways sent object[]
Role keys of the user. Updates from the wxrks 4.0 app send them as one comma-separated text.
statealways sent string
State.
statusalways sent stringDISABLED INACTIVE ACTIVE
User status.
supported_language_pairsalways sent object[]
Language pairs the user works in.
timezonealways sent string
Time zone.
under_reviewalways sent boolean
Whether the user is under review.
use_project_currencyalways sent boolean
Whether the user is paid in the project's currency.
uuidalways sent string (uuid)
Unique id of the user.
word_ratealways sent number
Rate per word.
Example body
{
  "address": "string",
  "address2": "string",
  "bio": "string",
  "birth_date": 0,
  "cell_phone": "string",
  "city": "string",
  "company_name": "string",
  "contract_signed": false,
  "country": "string",
  "currency": "string",
  "custom_fields": {},
  "daily_rate": 0,
  "email": "string",
  "event_type": "NEW_USER",
  "hourly_rate": 0,
  "id": 0,
  "minimum_fee": 0,
  "name": "string",
  "notes": "string",
  "on_payoneer": false,
  "pages_rate": 0,
  "payment_method": "string",
  "phone": "string",
  "postal_code": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "role": [],
  "state": "string",
  "status": "DISABLED",
  "supported_language_pairs": [],
  "timezone": "string",
  "under_review": false,
  "use_project_currency": false,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "word_rate": 0
}

POSTORG_UNIT_UPDATE

Org. Unit Updated

An org unit is updated. The body carries the new values only.

Body · 77 fields

OrgUnitUpdateEvent

account_codealways sent string
Accounting code for revenue.
address_additional_info string
Additional address details.
address_city string
City of the address.
address_neighborhood string
Neighborhood of the address.
address_number string
Street number of the address.
address_state string
State of the address.
address_street string
Street of the address.
address_zip string
Postal code of the address.
auto_billingalways sent boolean
Whether billing is automatic.
autopilot_enabledalways sent boolean
Whether autopilot is on.
billing_emailalways sent string
E-mail for invoices.
categorization_disabledalways sent boolean
Whether categorization is off.
client_languagesalways sent string
Languages of the org unit.
confidence_match_over_repetition_enabledalways sent boolean
Whether confidence matches win over repetitions.
consolidate_projectsalways sent boolean
Whether projects are consolidated on invoices.
contact_notesalways sent string
Notes about how to contact the org unit.
contact_person_email_notificationsalways sent boolean
Whether the contact person gets e-mails.
continuous_platform_tagalways sent string
Tag for continuous localization.
continuous_project_configalways sent string
Settings of continuous projects.
costs_logfile_typealways sent string
Which analysis costs are calculated from.
countryalways sent string
Country code.
currencyalways sent string
Currency code.
custom_fieldsalways sent object
Custom field values of the org unit.
custom_receivable_by_useralways sent boolean
Whether receivables are customized per user.
days_until_payment_duealways sent integer (int64)
Days until an invoice is due.
default_contact_person_emailalways sent string
E-mail of the default contact person.
default_contact_person_namealways sent string
Name of the default contact person.
default_contact_person_uuidalways sent string (uuid)
Default contact person.
default_project_manager_emailalways sent string
E-mail of the default project manager.
default_project_manager_namealways sent string
Name of the default project manager.
default_project_manager_uuidalways sent string (uuid)
Default project manager.
default_source_languagealways sent string
Default source language code.
event_typealways sent stringORG_UNIT_UPDATE
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the org unit.
invoice_grouping_keyalways sent string
How projects are grouped on invoices.
invoice_infoalways sent string
Text printed on invoices.
invoicing_typealways sent string
How often the org unit is invoiced.
isolated_tagsalways sent boolean
Whether the org unit's tags are kept apart.
locale_regionalways sent object
Language code to region.
mobilealways sent string
Mobile number.
namealways sent string
Org unit name.
notesalways sent string
Internal notes.
notify_project_commentsalways sent boolean
Whether project comments are notified.
notify_zendesk_enabledalways sent boolean
Whether Zendesk is notified.
nt_match_over_repetition_enabledalways sent boolean
Whether non-translatable matches win over repetitions.
override_default_regexalways sent boolean
Whether the regex replaces the default one.
payment_methodalways sent string
How the org unit pays.
phonealways sent string
Phone number.
project_automation_enabledalways sent boolean
Whether project automation is on.
project_count_words_fromalways sent string
Which count project words come from.
project_manager_email_notificationsalways sent boolean
Whether the project manager gets e-mails.
quote_notesalways sent object[]
Notes printed on quotes.
regexalways sent string
Custom segmentation or protection regex.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
send_available_tasks_emailalways sent boolean
Whether vendors get the available tasks e-mail.
send_invoice_to_requesteralways sent boolean
Whether invoices go to the requester.
send_quote_autoalways sent boolean
Whether quotes are sent automatically.
send_receivable_email_notificationalways sent boolean
Whether receivable e-mails are sent.
settingsalways sent object
Editor and branding settings of the org unit.
tagsalways sent object[]
Org unit tags.
task_count_words_fromalways sent string
Which count task words come from.
task_payment_typealways sent string
How tasks are paid.
tax_info_issue_nfe boolean
Brazilian tax setting: issue an electronic invoice.
tax_info_municipal_registration string
Municipal tax registration.
tax_info_require_purchase_order boolean
Whether a purchase order is required.
tax_info_retain_ir boolean
Brazilian tax setting: retain income tax.
tax_info_simples_nacional boolean
Brazilian tax setting: Simples Nacional.
taxpayer_idalways sent string
Tax identification number.
timezonealways sent string
Time zone of the org unit.
tm_match_over_repetition_enabledalways sent boolean
Whether TM matches win over repetitions.
tracking_categoryalways sent string
Accounting tracking category.
tracking_category_typealways sent string
Type of the accounting tracking category.
uuidalways sent string (uuid)
Unique id of the org unit.
vendor_email_notificationsalways sent boolean
Whether vendors get e-mails.
websitealways sent string
Website address.
xero_idalways sent string
Id of the org unit in Xero.
Example body
{
  "account_code": "string",
  "address_additional_info": "string",
  "address_city": "string",
  "address_neighborhood": "string",
  "address_number": "string",
  "address_state": "string",
  "address_street": "string",
  "address_zip": "string",
  "auto_billing": false,
  "autopilot_enabled": false,
  "billing_email": "string",
  "categorization_disabled": false,
  "client_languages": "string",
  "confidence_match_over_repetition_enabled": false,
  "consolidate_projects": false,
  "contact_notes": "string",
  "contact_person_email_notifications": false,
  "continuous_platform_tag": "string",
  "continuous_project_config": "string",
  "costs_logfile_type": "string",
  "country": "string",
  "currency": "string",
  "custom_fields": {},
  "custom_receivable_by_user": false,
  "days_until_payment_due": 0,
  "default_contact_person_email": "string",
  "default_contact_person_name": "string",
  "default_contact_person_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "default_project_manager_email": "string",
  "default_project_manager_name": "string",
  "default_project_manager_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "default_source_language": "string",
  "event_type": "ORG_UNIT_UPDATE",
  "id": 0,
  "invoice_grouping_key": "string",
  "invoice_info": "string",
  "invoicing_type": "string",
  "isolated_tags": false,
  "locale_region": {},
  "mobile": "string",
  "name": "string",
  "notes": "string",
  "notify_project_comments": false,
  "notify_zendesk_enabled": false,
  "nt_match_over_repetition_enabled": false,
  "override_default_regex": false,
  "payment_method": "string",
  "phone": "string",
  "project_automation_enabled": false,
  "project_count_words_from": "string",
  "project_manager_email_notifications": false,
  "quote_notes": [],
  "regex": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "send_available_tasks_email": false,
  "send_invoice_to_requester": false,
  "send_quote_auto": false,
  "send_receivable_email_notification": false,
  "settings": {},
  "tags": [],
  "task_count_words_from": "string",
  "task_payment_type": "string",
  "tax_info_issue_nfe": false,
  "tax_info_municipal_registration": "string",
  "tax_info_require_purchase_order": false,
  "tax_info_retain_ir": false,
  "tax_info_simples_nacional": false,
  "taxpayer_id": "string",
  "timezone": "string",
  "tm_match_over_repetition_enabled": false,
  "tracking_category": "string",
  "tracking_category_type": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendor_email_notifications": false,
  "website": "string",
  "xero_id": "string"
}

POSTORG_UPDATE

Organization Updated

An organization is updated. The body carries the new values only.

Body · 8 fields

OrgUpdateEvent

countryalways sent string
Country code.
custom_fieldsalways sent object
Custom field values of the organization.
event_typealways sent stringORG_UPDATE
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the organization.
namealways sent string
Organization name.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
uuidalways sent string (uuid)
Unique id of the organization.
Example body
{
  "country": "string",
  "custom_fields": {},
  "event_type": "ORG_UPDATE",
  "id": 0,
  "name": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

POSTPROJECT_INGESTION_COMPLETED

Project Ingestion Completed

Every file of a project was parsed, or failed to be.

Body · 9 fields

ProjectIngestionCompletedEvent

ci_tag string
The CI tag of the event's project, when it has one.
event_typealways sent stringPROJECT_INGESTION_COMPLETED
The event's type key, repeated in the details.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the project.
project_namealways sent string
Name of the project.
project_uuidalways sent string (uuid)
The project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
target_locales object[]
The project's target locales.
workflows object[]
The codes of the project's workflow steps, such as TRANSLATION and REVIEW.
Example body
{
  "ci_tag": "string",
  "event_type": "PROJECT_INGESTION_COMPLETED",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_name": "string",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "target_locales": [],
  "workflows": []
}

POSTPROJECT_LOGFILE_COMPLETED

Project Logfile Completed

A logfile (analysis) finishes: one created with Create Logfile or in the app, or one wxrks runs to calculate costs. The body carries no word counts: call details.logfile for them.

Body · 13 fields

ProjectLogfileCompletedEvent

analysis_type string
The kind of logfile, such as PRE_ANALYSE or POST_ANALYSE.
analysis_uuidalways sent string (uuid)
The logfile's id in the logfile calls.
ci_tag string
The CI tag of the event's project, when it has one.
completed_date integer (int64)
When it finished. Unix time in milliseconds.
creation_date integer (int64)
When the logfile was requested. Unix time in milliseconds.
details map<string, WebhookApiCall>
logfile: the call that returns the logfile, with its word counts.
event_typealways sent string
PROJECT_LOGFILE_COMPLETED.
org_unit_uuid string (uuid)
The project's org unit.
project_name string
The name of the project.
project_uuidalways sent string (uuid)
The logfile's project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
task_uuids object[]
The tasks the logfile was run for, when it was run for some.
Example body
{
  "analysis_type": "string",
  "analysis_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ci_tag": "string",
  "completed_date": 0,
  "creation_date": 0,
  "details": {
    "logfile": {
      "action": "GET",
      "description": "string",
      "url": "string"
    }
  },
  "event_type": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_name": "string",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "task_uuids": []
}

POSTPROJECT_STATUS_CHANGE

Project Status Changed

A project's status changes.

Body · 26 fields

ProjectStatusChangeEvent

ci_tagalways sent string
Continuous-localization tag of the project.
costs_statusalways sent stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED
Where the cost calculation stands.
creation_timestampalways sent integer (int64)
When the project was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the project.
creator_emailalways sent string
E-mail of the person who created the project.
currencyalways sent string
Currency code of the project's costs.
custom_field_valuesalways sent object
The project's custom field values by key: the field name in lower case, with anything but letters and digits as _ (Contract value is contract_value). Renaming a field changes its key. Empty values, and fields whose keys collide, are left out.
custom_fieldsalways sent object
Custom field values of the project.
event_typealways sent stringPROJECT_STATUS_CHANGE
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the project.
instructionsalways sent string
Instructions for the people working on the project.
namealways sent string
Code wxrks gives the project (B-…), shown under its title.
new_statusalways sent stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS
Status after the change, as its key.
notesalways sent string
Internal notes.
org_unit_uuidalways sent string (uuid)
Org unit (client) the project belongs to.
previous_statusalways sent stringDELETED CANCELLED DRAFT PENDING APPROVED DELIVERED INVOICED PARTIALLY_INVOICED NOT_INVOICED CONTINUOUS
Status before the change, as its key.
referencealways sent string
Project title, shown as the heading of the project page.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_localealways sent string
Source language code.
statusalways sent stringDeleted Cancelled Draft Pending Approved Delivered Invoiced Partially Invoiced Not Invoiced Continuous
Project status, as its display name.
tagsalways sent object[]
Project tags.
target_localesalways sent object[]
Target language codes.
total_costalways sent number
Total cost of the project in its currency, with 2 decimals. Empty until costs are calculated.
uuidalways sent string (uuid)
Unique id of the project.
workflowsalways sent object[]
Codes of the project's workflow steps.
Example body
{
  "ci_tag": "string",
  "costs_status": "CREATING",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "currency": "string",
  "custom_field_values": {},
  "custom_fields": {},
  "event_type": "PROJECT_STATUS_CHANGE",
  "id": 0,
  "instructions": "string",
  "name": "string",
  "new_status": "DELETED",
  "notes": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "previous_status": "DELETED",
  "reference": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "status": "Deleted",
  "tags": [],
  "target_locales": [],
  "total_cost": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflows": []
}

POSTPROJECT_TRANSLATION_FINISHED

Project Translation Finished

An automatic translation of a project ends: every work unit of the run was translated, or failed to be.

Body · 11 fields

ProjectTranslationFinishedEvent

ci_tag string
The CI tag of the event's project, when it has one.
event_typealways sent stringPROJECT_TRANSLATION_FINISHED
The event's type key, repeated in the details.
notify_on_completionalways sent boolean
Whether people asked to be notified when it ends.
project_idalways sent integer (int64)
Numeric id of the project.
project_namealways sent string
Name of the project.
project_uuidalways sent string (uuid)
The project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
total_work_unitsalways sent integer (int64)
Work units in this run.
total_work_units_completedalways sent integer (int64)
Work units translated by this run.
total_work_units_failedalways sent integer (int64)
Work units whose translation failed.
Example body
{
  "ci_tag": "string",
  "event_type": "PROJECT_TRANSLATION_FINISHED",
  "notify_on_completion": false,
  "project_id": 0,
  "project_name": "string",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "total_work_units": 0,
  "total_work_units_completed": 0,
  "total_work_units_failed": 0
}

POSTPROJECT_UPDATE

Project Updated

A project is updated. The body carries the new values only.

Body · 24 fields

ProjectUpdateEvent

ci_tagalways sent string
Continuous-localization tag of the project.
costs_statusalways sent stringCREATING UPDATING COMPLETED COMPLETED_WARN LOGFILE_ERROR INGESTION_ERROR ERROR NOT_CALCULATED
Where the cost calculation stands.
creation_timestampalways sent integer (int64)
When the project was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the project.
creator_emailalways sent string
E-mail of the person who created the project.
currencyalways sent string
Currency code of the project's costs.
custom_field_valuesalways sent object
The project's custom field values by key: the field name in lower case, with anything but letters and digits as _ (Contract value is contract_value). Renaming a field changes its key. Empty values, and fields whose keys collide, are left out.
custom_fieldsalways sent object
Custom field values of the project.
event_typealways sent stringPROJECT_UPDATE
The event's type key, repeated in the details.
idalways sent integer (int64)
Numeric id of the project.
instructionsalways sent string
Instructions for the people working on the project.
namealways sent string
Code wxrks gives the project (B-…), shown under its title.
notesalways sent string
Internal notes.
org_unit_uuidalways sent string (uuid)
Org unit (client) the project belongs to.
referencealways sent string
Project title, shown as the heading of the project page.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_localealways sent string
Source language code.
statusalways sent stringDeleted Cancelled Draft Pending Approved Delivered Invoiced Partially Invoiced Not Invoiced Continuous
Project status, as its display name.
tagsalways sent object[]
Project tags.
target_localesalways sent object[]
Target language codes.
total_costalways sent number
Total cost of the project in its currency, with 2 decimals. Empty until costs are calculated.
uuidalways sent string (uuid)
Unique id of the project.
workflowsalways sent object[]
Codes of the project's workflow steps.
Example body
{
  "ci_tag": "string",
  "costs_status": "CREATING",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "currency": "string",
  "custom_field_values": {},
  "custom_fields": {},
  "event_type": "PROJECT_UPDATE",
  "id": 0,
  "instructions": "string",
  "name": "string",
  "notes": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "status": "Deleted",
  "tags": [],
  "target_locales": [],
  "total_cost": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflows": []
}

POSTSEGMENT_COMMENT_CREATED

Segment Comment Created

A comment or a reply is added to a segment, in the editor or with Create Segment Comment. Private comments and comments imported from a bilingual file are not sent. The body has no comment text: read it with List Work Unit Comments.

Body · 14 fields

SegmentCommentCreatedEvent

author_uuidalways sent string (uuid)
Person who wrote the comment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the comment was written. Unix time in milliseconds.
event_typealways sent stringSEGMENT_COMMENT_CREATED
The event's type key, repeated in the details.
file_indexalways sent integer (int64)
Position of the segment in the file, from 0.
idalways sent string (uuid)
Unique id of the comment.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the project.
parent_uuid string (uuid)
The comment this one replies to; missing on a new thread.
project_uuidalways sent string (uuid)
Project of the file.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
segment_numberalways sent integer (int64)
Segment number as people see it, from 1.
work_idalways sent string (uuid)
Work id of the file.
work_unit_uuidsalways sent object[]
Work units of the file.
Example body
{
  "author_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ci_tag": "string",
  "creation_timestamp": 0,
  "event_type": "SEGMENT_COMMENT_CREATED",
  "file_index": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "parent_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "segment_number": 0,
  "work_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "work_unit_uuids": []
}

POSTTASK_ASSIGNED

Task Assigned

A task is assigned. Not sent while the assignment waits for the vendor's acceptance.

Body · 34 fields

TaskAssignedEvent

acceptance_datealways sent integer (int64)
When the assignee accepted the task. Unix time in milliseconds.
assign_datealways sent integer (int64)
When the task was assigned. Unix time in milliseconds.
assigned_by_emailalways sent string
E-mail of the person who assigned the task.
assigned_by_namealways sent string
Name of the person who assigned the task.
assigneealways sent string
Name of the person the task is assigned to.
assignee_emailalways sent string
E-mail of the person the task is assigned to.
assignee_word_ratealways sent number
Rate per word paid to the assignee.
begin_indexalways sent integer (int64)
Index of the task's first segment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the task was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the task.
creator_emailalways sent string
E-mail of the person who created the task.
custom_fieldsalways sent object
Custom field values of the task.
delivery_datealways sent integer (int64)
When the task was delivered. Unix time in milliseconds.
due_datealways sent integer (int64)
When the task is due. Unix time in milliseconds.
end_indexalways sent integer (int64)
Index of the task's last segment.
event_typealways sent stringTASK_ASSIGNED
The event's type key, repeated in the details.
filesalways sent object[]
Names of the task's files.
formatted_due_datealways sent string
due_date as MM/dd/yyyy HH:mm:ss UTC, such as 11/30/2026 17:00:00 UTC; empty when the task has no due date.
idalways sent integer (int64)
Numeric id of the task.
instructionsalways sent string
Instructions for the assignee.
minimum_score_requiredalways sent number
Minimum quality score required to take the task.
namealways sent string
The name of the task's project. Task Updated carries the task's own name here.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the task's project.
project_uuidalways sent string (uuid)
Project the task belongs to.
reference string
The reference of the task's project.
reference_filesalways sent object[]
Names of the task's reference files.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
scheduled_datealways sent integer (int64)
When the task is scheduled to start. Unix time in milliseconds.
skip_datealways sent integer (int64)
When the task was skipped. Unix time in milliseconds.
statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Task status.
uuidalways sent string (uuid)
Unique id of the task.
workflowalways sent string
Workflow step of the task.
Example body
{
  "acceptance_date": 0,
  "assign_date": 0,
  "assigned_by_email": "string",
  "assigned_by_name": "string",
  "assignee": "string",
  "assignee_email": "string",
  "assignee_word_rate": 0,
  "begin_index": 0,
  "ci_tag": "string",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "custom_fields": {},
  "delivery_date": 0,
  "due_date": 0,
  "end_index": 0,
  "event_type": "TASK_ASSIGNED",
  "files": [],
  "formatted_due_date": "string",
  "id": 0,
  "instructions": "string",
  "minimum_score_required": 0,
  "name": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "reference_files": [],
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "scheduled_date": 0,
  "skip_date": 0,
  "status": "CANCELLED",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTTASK_DUE_DATE_CHANGE

Task Due Date Changed

A task's due date is changed or removed, on the task or in a bulk update. A due date set when tasks are created is not a change.

Body · 37 fields

TaskDueDateChangeEvent

acceptance_datealways sent integer (int64)
When the assignee accepted the task. Unix time in milliseconds.
assign_datealways sent integer (int64)
When the task was assigned. Unix time in milliseconds.
assigned_by_emailalways sent string
E-mail of the person who assigned the task.
assigned_by_namealways sent string
Name of the person who assigned the task.
assigneealways sent string
Name of the person the task is assigned to.
assignee_emailalways sent string
E-mail of the person the task is assigned to.
assignee_word_ratealways sent number
Rate per word paid to the assignee.
begin_indexalways sent integer (int64)
Index of the task's first segment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the task was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the task.
creator_emailalways sent string
E-mail of the person who created the task.
custom_fieldsalways sent object
Custom field values of the task.
delivery_datealways sent integer (int64)
When the task was delivered. Unix time in milliseconds.
due_datealways sent integer (int64)
When the task is due. Unix time in milliseconds.
end_indexalways sent integer (int64)
Index of the task's last segment.
event_typealways sent stringTASK_DUE_DATE_CHANGE
The event's type key, repeated in the details.
filesalways sent object[]
Names of the task's files.
formatted_due_datealways sent string
due_date as MM/dd/yyyy HH:mm:ss UTC, such as 11/30/2026 17:00:00 UTC; empty when the task has no due date.
idalways sent integer (int64)
Numeric id of the task.
instructionsalways sent string
Instructions for the assignee.
minimum_score_requiredalways sent number
Minimum quality score required to take the task.
namealways sent string
The name of the task's project. Task Updated carries the task's own name here.
new_due_date integer (int64)
Due date after the change; missing when it was removed. Unix time in milliseconds.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the task's project.
previous_due_date integer (int64)
Due date before the change; missing when there was none. Unix time in milliseconds.
project_uuidalways sent string (uuid)
Project the task belongs to.
reference string
The reference of the task's project.
reference_filesalways sent object[]
Names of the task's reference files.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
scheduled_datealways sent integer (int64)
When the task is scheduled to start. Unix time in milliseconds.
skip_datealways sent integer (int64)
When the task was skipped. Unix time in milliseconds.
statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Task status.
uuidalways sent string (uuid)
Unique id of the task.
work_unit_uuidalways sent string (uuid)
Work unit the task belongs to.
workflowalways sent string
Workflow step of the task.
Example body
{
  "acceptance_date": 0,
  "assign_date": 0,
  "assigned_by_email": "string",
  "assigned_by_name": "string",
  "assignee": "string",
  "assignee_email": "string",
  "assignee_word_rate": 0,
  "begin_index": 0,
  "ci_tag": "string",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "custom_fields": {},
  "delivery_date": 0,
  "due_date": 0,
  "end_index": 0,
  "event_type": "TASK_DUE_DATE_CHANGE",
  "files": [],
  "formatted_due_date": "string",
  "id": 0,
  "instructions": "string",
  "minimum_score_required": 0,
  "name": "string",
  "new_due_date": 0,
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "previous_due_date": 0,
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "reference_files": [],
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "scheduled_date": 0,
  "skip_date": 0,
  "status": "CANCELLED",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "work_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTTASK_OVERDUE

Task Overdue

A task that is ASSIGNED, PENDING_ACCEPTANCE or PENDING_CONFIRMATION passes its due date. Sent once per due date: a new due date that passes again sends it again. Checked every 5 minutes, for due dates up to a day old.

Body · 35 fields

TaskOverdueEvent

acceptance_datealways sent integer (int64)
When the assignee accepted the task. Unix time in milliseconds.
assign_datealways sent integer (int64)
When the task was assigned. Unix time in milliseconds.
assigned_by_emailalways sent string
E-mail of the person who assigned the task.
assigned_by_namealways sent string
Name of the person who assigned the task.
assigneealways sent string
Name of the person the task is assigned to.
assignee_emailalways sent string
E-mail of the person the task is assigned to.
assignee_word_ratealways sent number
Rate per word paid to the assignee.
begin_indexalways sent integer (int64)
Index of the task's first segment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the task was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the task.
creator_emailalways sent string
E-mail of the person who created the task.
custom_fieldsalways sent object
Custom field values of the task.
delivery_datealways sent integer (int64)
When the task was delivered. Unix time in milliseconds.
due_datealways sent integer (int64)
When the task is due. Unix time in milliseconds.
end_indexalways sent integer (int64)
Index of the task's last segment.
event_typealways sent stringTASK_OVERDUE
The event's type key, repeated in the details.
filesalways sent object[]
Names of the task's files.
formatted_due_datealways sent string
due_date as MM/dd/yyyy HH:mm:ss UTC, such as 11/30/2026 17:00:00 UTC; empty when the task has no due date.
idalways sent integer (int64)
Numeric id of the task.
instructionsalways sent string
Instructions for the assignee.
minimum_score_requiredalways sent number
Minimum quality score required to take the task.
namealways sent string
The name of the task's project. Task Updated carries the task's own name here.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the task's project.
project_uuidalways sent string (uuid)
Project the task belongs to.
reference string
The reference of the task's project.
reference_filesalways sent object[]
Names of the task's reference files.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
scheduled_datealways sent integer (int64)
When the task is scheduled to start. Unix time in milliseconds.
skip_datealways sent integer (int64)
When the task was skipped. Unix time in milliseconds.
statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Task status.
uuidalways sent string (uuid)
Unique id of the task.
work_unit_uuidalways sent string (uuid)
Work unit the task belongs to.
workflowalways sent string
Workflow step of the task.
Example body
{
  "acceptance_date": 0,
  "assign_date": 0,
  "assigned_by_email": "string",
  "assigned_by_name": "string",
  "assignee": "string",
  "assignee_email": "string",
  "assignee_word_rate": 0,
  "begin_index": 0,
  "ci_tag": "string",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "custom_fields": {},
  "delivery_date": 0,
  "due_date": 0,
  "end_index": 0,
  "event_type": "TASK_OVERDUE",
  "files": [],
  "formatted_due_date": "string",
  "id": 0,
  "instructions": "string",
  "minimum_score_required": 0,
  "name": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "reference_files": [],
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "scheduled_date": 0,
  "skip_date": 0,
  "status": "CANCELLED",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "work_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTTASK_STATUS_CHANGE

Task Status Changed

A task's status changes.

Body · 36 fields

TaskStatusChangeEvent

acceptance_datealways sent integer (int64)
When the assignee accepted the task. Unix time in milliseconds.
assign_datealways sent integer (int64)
When the task was assigned. Unix time in milliseconds.
assigned_by_emailalways sent string
E-mail of the person who assigned the task.
assigned_by_namealways sent string
Name of the person who assigned the task.
assigneealways sent string
Name of the person the task is assigned to.
assignee_emailalways sent string
E-mail of the person the task is assigned to.
assignee_word_ratealways sent number
Rate per word paid to the assignee.
begin_indexalways sent integer (int64)
Index of the task's first segment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the task was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the task.
creator_emailalways sent string
E-mail of the person who created the task.
custom_fieldsalways sent object
Custom field values of the task.
delivery_datealways sent integer (int64)
When the task was delivered. Unix time in milliseconds.
due_datealways sent integer (int64)
When the task is due. Unix time in milliseconds.
end_indexalways sent integer (int64)
Index of the task's last segment.
event_typealways sent stringTASK_STATUS_CHANGE
The event's type key, repeated in the details.
filesalways sent object[]
Names of the task's files.
formatted_due_datealways sent string
due_date as MM/dd/yyyy HH:mm:ss UTC, such as 11/30/2026 17:00:00 UTC; empty when the task has no due date.
idalways sent integer (int64)
Numeric id of the task.
instructionsalways sent string
Instructions for the assignee.
minimum_score_requiredalways sent number
Minimum quality score required to take the task.
namealways sent string
The name of the task's project. Task Updated carries the task's own name here.
new_statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Status after the change.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the task's project.
previous_statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Status before the change.
project_uuidalways sent string (uuid)
Project the task belongs to.
reference string
The reference of the task's project.
reference_filesalways sent object[]
Names of the task's reference files.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
scheduled_datealways sent integer (int64)
When the task is scheduled to start. Unix time in milliseconds.
skip_datealways sent integer (int64)
When the task was skipped. Unix time in milliseconds.
statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Task status.
uuidalways sent string (uuid)
Unique id of the task.
workflowalways sent string
Workflow step of the task.
Example body
{
  "acceptance_date": 0,
  "assign_date": 0,
  "assigned_by_email": "string",
  "assigned_by_name": "string",
  "assignee": "string",
  "assignee_email": "string",
  "assignee_word_rate": 0,
  "begin_index": 0,
  "ci_tag": "string",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "custom_fields": {},
  "delivery_date": 0,
  "due_date": 0,
  "end_index": 0,
  "event_type": "TASK_STATUS_CHANGE",
  "files": [],
  "formatted_due_date": "string",
  "id": 0,
  "instructions": "string",
  "minimum_score_required": 0,
  "name": "string",
  "new_status": "CANCELLED",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "previous_status": "CANCELLED",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "reference_files": [],
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "scheduled_date": 0,
  "skip_date": 0,
  "status": "CANCELLED",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTTASK_UPDATE

Task Updated

A task is updated. The body carries the new values only.

Body · 32 fields

TaskUpdateEvent

acceptance_datealways sent integer (int64)
When the assignee accepted the task. Unix time in milliseconds.
assign_datealways sent integer (int64)
When the task was assigned. Unix time in milliseconds.
assigned_by_emailalways sent string
E-mail of the person who assigned the task.
assigned_by_namealways sent string
Name of the person who assigned the task.
assigneealways sent string
Name of the person the task is assigned to.
assignee_emailalways sent string
E-mail of the person the task is assigned to.
assignee_word_ratealways sent number
Rate per word paid to the assignee.
begin_indexalways sent integer (int64)
Index of the task's first segment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the task was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the task.
creator_emailalways sent string
E-mail of the person who created the task.
custom_fieldsalways sent object
Custom field values of the task.
delivery_datealways sent integer (int64)
When the task was delivered. Unix time in milliseconds.
due_datealways sent integer (int64)
When the task is due. Unix time in milliseconds.
end_indexalways sent integer (int64)
Index of the task's last segment.
event_typealways sent stringTASK_UPDATE
The event's type key, repeated in the details.
filesalways sent object[]
Names of the task's files.
idalways sent integer (int64)
Numeric id of the task.
instructionsalways sent string
Instructions for the assignee.
minimum_score_requiredalways sent number
Minimum quality score required to take the task.
namealways sent string
Task name.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the task's project.
project_uuidalways sent string (uuid)
Project the task belongs to.
reference_filesalways sent object[]
Names of the task's reference files.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
scheduled_datealways sent integer (int64)
When the task is scheduled to start. Unix time in milliseconds.
skip_datealways sent integer (int64)
When the task was skipped. Unix time in milliseconds.
statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Task status.
uuidalways sent string (uuid)
Unique id of the task.
workflowalways sent string
Workflow step of the task.
Example body
{
  "acceptance_date": 0,
  "assign_date": 0,
  "assigned_by_email": "string",
  "assigned_by_name": "string",
  "assignee": "string",
  "assignee_email": "string",
  "assignee_word_rate": 0,
  "begin_index": 0,
  "ci_tag": "string",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "custom_fields": {},
  "delivery_date": 0,
  "due_date": 0,
  "end_index": 0,
  "event_type": "TASK_UPDATE",
  "files": [],
  "id": 0,
  "instructions": "string",
  "minimum_score_required": 0,
  "name": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference_files": [],
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "scheduled_date": 0,
  "skip_date": 0,
  "status": "CANCELLED",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTTASK_VENDOR_RESPONSE

Task Vendor Response

The vendor accepts or declines a task pending their acceptance. A decline is sent before the task is taken back from the vendor, so assignee names who declined.

Body · 36 fields

TaskVendorResponseEvent

acceptance_datealways sent integer (int64)
When the assignee accepted the task. Unix time in milliseconds.
assign_datealways sent integer (int64)
When the task was assigned. Unix time in milliseconds.
assigned_by_emailalways sent string
E-mail of the person who assigned the task.
assigned_by_namealways sent string
Name of the person who assigned the task.
assigneealways sent string
Name of the person the task is assigned to.
assignee_emailalways sent string
E-mail of the person the task is assigned to.
assignee_word_ratealways sent number
Rate per word paid to the assignee.
begin_indexalways sent integer (int64)
Index of the task's first segment.
ci_tag string
The CI tag of the event's project, when it has one.
creation_timestampalways sent integer (int64)
When the task was created. Unix time in milliseconds.
creatoralways sent string
Name of the person who created the task.
creator_emailalways sent string
E-mail of the person who created the task.
custom_fieldsalways sent object
Custom field values of the task.
delivery_datealways sent integer (int64)
When the task was delivered. Unix time in milliseconds.
due_datealways sent integer (int64)
When the task is due. Unix time in milliseconds.
end_indexalways sent integer (int64)
Index of the task's last segment.
event_typealways sent stringTASK_VENDOR_RESPONSE
The event's type key, repeated in the details.
filesalways sent object[]
Names of the task's files.
formatted_due_datealways sent string
due_date as MM/dd/yyyy HH:mm:ss UTC, such as 11/30/2026 17:00:00 UTC; empty when the task has no due date.
idalways sent integer (int64)
Numeric id of the task.
instructionsalways sent string
Instructions for the assignee.
minimum_score_requiredalways sent number
Minimum quality score required to take the task.
namealways sent string
The name of the task's project. Task Updated carries the task's own name here.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the task's project.
project_uuidalways sent string (uuid)
Project the task belongs to.
reference string
The reference of the task's project.
reference_filesalways sent object[]
Names of the task's reference files.
responsealways sent stringACCEPTED DECLINED
Whether the vendor accepted or declined.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
scheduled_datealways sent integer (int64)
When the task is scheduled to start. Unix time in milliseconds.
skip_datealways sent integer (int64)
When the task was skipped. Unix time in milliseconds.
statusalways sent stringCANCELLED PENDING PENDING_ACCEPTANCE PENDING_CONFIRMATION SCHEDULED EXPIRED ASSIGNED DELIVERED INVOICED PAID NOT_INVOICED SKIPPED
Task status.
uuidalways sent string (uuid)
Unique id of the task.
work_unit_uuidalways sent string (uuid)
Work unit the task belongs to.
workflowalways sent string
Workflow step of the task.
Example body
{
  "acceptance_date": 0,
  "assign_date": 0,
  "assigned_by_email": "string",
  "assigned_by_name": "string",
  "assignee": "string",
  "assignee_email": "string",
  "assignee_word_rate": 0,
  "begin_index": 0,
  "ci_tag": "string",
  "creation_timestamp": 0,
  "creator": "string",
  "creator_email": "string",
  "custom_fields": {},
  "delivery_date": 0,
  "due_date": 0,
  "end_index": 0,
  "event_type": "TASK_VENDOR_RESPONSE",
  "files": [],
  "formatted_due_date": "string",
  "id": 0,
  "instructions": "string",
  "minimum_score_required": 0,
  "name": "string",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "reference_files": [],
  "response": "ACCEPTED",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "scheduled_date": 0,
  "skip_date": 0,
  "status": "CANCELLED",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "work_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTTRANSLATION_KIT_JOB_FINISHED

Translation Kit Job Finished

A translation kit job ends, with COMPLETED or FAILED: an export kit, translated files, source files, or a bulk import. The body carries no download link: call details.job for one.

Body · 14 fields

TranslationKitJobFinishedEvent

ci_tag string
The CI tag of the event's project, when it has one.
creation_datealways sent integer (int64)
When the job was created. Unix time in milliseconds.
details map<string, WebhookApiCall>
job: the call that returns the job, with its download link once it has completed.
ending_datealways sent integer (int64)
When the job ended. Unix time in milliseconds.
event_typealways sent stringTRANSLATION_KIT_JOB_FINISHED
The event's type key, repeated in the details.
idalways sent string (uuid)
The translation kit job.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the project.
project_namealways sent string
Name of the project.
project_uuidalways sent string (uuid)
The project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
statusalways sent stringCOMPLETED FAILED STOPPED ABANDONED UNKNOWN
How the job ended.
translation_kit_typealways sent stringEXPORT_XLIFF IMPORT_XLIFF IMPORT_XLSX IMPORT_DOCX LOC_KIT TRANSLATED_FILES SOURCE_FILES
What the job built or imported.
work_unit_uuids object[]
Work units the job was limited to.
Example body
{
  "ci_tag": "string",
  "creation_date": 0,
  "details": {
    "job": {
      "action": "GET",
      "description": "string",
      "url": "string"
    }
  },
  "ending_date": 0,
  "event_type": "TRANSLATION_KIT_JOB_FINISHED",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_name": "string",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "status": "COMPLETED",
  "translation_kit_type": "EXPORT_XLIFF",
  "work_unit_uuids": []
}

POSTUSER_UPDATE

User Updated

A user is updated. The body carries the new values only.

Body · 36 fields

UserUpdateEvent

addressalways sent string
Address line 1.
address2always sent string
Address line 2.
bioalways sent string
Short biography.
birth_datealways sent integer (int64)
Date of birth. Unix time in milliseconds.
cell_phonealways sent string
Mobile number.
cityalways sent string
City.
company_namealways sent string
Company name.
contract_signedalways sent boolean
Whether the user signed the contract.
countryalways sent string
Country code.
currencyalways sent string
Currency code.
custom_fieldsalways sent object
Custom field values of the user.
daily_ratealways sent number
Rate per day.
emailalways sent string
User e-mail.
event_typealways sent stringUSER_UPDATE
The event's type key, repeated in the details.
hourly_ratealways sent number
Rate per hour.
idalways sent integer (int64)
Numeric id of the user.
minimum_feealways sent number
Minimum fee per task.
namealways sent string
User name.
notesalways sent string
Internal notes.
on_payoneeralways sent boolean
Whether the user is paid through Payoneer.
pages_ratealways sent number
Rate per page.
payment_methodalways sent string
How the user is paid.
phonealways sent string
Phone number.
postal_codealways sent string
Postal code.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
rolealways sent object[]
Role keys of the user. Updates from the wxrks 4.0 app send them as one comma-separated text.
statealways sent string
State.
statusalways sent stringDISABLED INACTIVE ACTIVE
User status.
supported_language_pairsalways sent object[]
Language pairs the user works in.
tags object[]
User tags. Sent only by the wxrks 4.0 app.
timezonealways sent string
Time zone.
under_reviewalways sent boolean
Whether the user is under review.
use_project_currencyalways sent boolean
Whether the user is paid in the project's currency.
uuidalways sent string (uuid)
Unique id of the user.
word_ratealways sent number
Rate per word.
Example body
{
  "address": "string",
  "address2": "string",
  "bio": "string",
  "birth_date": 0,
  "cell_phone": "string",
  "city": "string",
  "company_name": "string",
  "contract_signed": false,
  "country": "string",
  "currency": "string",
  "custom_fields": {},
  "daily_rate": 0,
  "email": "string",
  "event_type": "USER_UPDATE",
  "hourly_rate": 0,
  "id": 0,
  "minimum_fee": 0,
  "name": "string",
  "notes": "string",
  "on_payoneer": false,
  "pages_rate": 0,
  "payment_method": "string",
  "phone": "string",
  "postal_code": "string",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "role": [],
  "state": "string",
  "status": "DISABLED",
  "supported_language_pairs": [],
  "tags": [],
  "timezone": "string",
  "under_review": false,
  "use_project_currency": false,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "word_rate": 0
}

POSTWEBHOOK_VALIDATION

Webhook Validation

Sent when a webhook is created, and again when it is activated with Toggle Webhook. The webhook becomes active when your server answers it with a 2xx within 3 seconds; wxrks tries up to three times.

Sent without X-BWX-Retry-Of.

Body · 7 fields

WebhookValidationEvent

attemptalways sent integer (int64)
Which of the three attempts this is, from 1.
event_typealways sent string
Always WEBHOOK_VALIDATION.
eventsalways sent object[]
The event type the webhook receives, as a list of one.
expected_responsealways sent string
A sentence that says how to answer.
messagealways sent string
A sentence that says what the request is for.
timestampalways sent integer (int64)
When the request was sent. Unix time in milliseconds.
webhook_uuidalways sent string (uuid)
The id of the webhook being validated.
Example body
{
  "attempt": 0,
  "event_type": "string",
  "events": [],
  "expected_response": "string",
  "message": "string",
  "timestamp": 0,
  "webhook_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

POSTWORK_UNIT_CREATED

Work Unit Created

A work unit's file is parsed and the work unit is ready, once per workflow step. A work unit whose creation failed is not sent.

Body · 15 fields

WorkUnitCreatedEvent

characters integer (int64)
Characters in the work unit.
ci_tag string
The CI tag of the event's project, when it has one.
event_typealways sent string
WORK_UNIT_CREATED.
filename string
The name of the work unit's file.
is_last_workflow boolean
Whether that step is the last one of the file's workflow.
org_unit_uuid string (uuid)
The project's org unit.
project_uuidalways sent string (uuid)
The work unit's project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_locale string
The work unit's source locale, such as en_us.
target_locale string
The work unit's target locale, such as pt_br.
total_segments integer (int64)
Segments in the work unit.
words integer (int64)
Words in the work unit.
work_unit_uuidalways sent string (uuid)
The work unit.
workflow string
The workflow step of the work unit, such as TRANSLATION.
Example body
{
  "characters": 0,
  "ci_tag": "string",
  "event_type": "string",
  "filename": "string",
  "is_last_workflow": false,
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "target_locale": "string",
  "total_segments": 0,
  "words": 0,
  "work_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflow": "string"
}

POSTWORK_UNIT_IMPORT_FINISHED

Work Unit Import Finished

An import of a bilingual file into a work unit ends, with IMPORTED or ERROR. The fields mean the same as in Get Work Unit Import.

Body · 22 fields

WorkUnitImportFinishedEvent

ci_tag string
The CI tag of the event's project, when it has one.
creation_datealways sent integer (int64)
When the import started. Unix time in milliseconds.
details map<string, WebhookApiCall>
import: the Get Work Unit Import call, which returns the import with its status, error and segment counts.
ending_datealways sent integer (int64)
When the import ended. Unix time in milliseconds.
erroralways sent stringWORK_UNIT_READ_ONLY WRONG_WORK_UNIT FILE_UNREADABLE NO_SEGMENTS TARGET_LANGUAGE_MISMATCH NO_SEGMENT_IDS NOTHING_UPDATED FAILED
Why the import failed; empty when it succeeded.
event_typealways sent stringWORK_UNIT_IMPORT_FINISHED
The event's type key, repeated in the details.
idalways sent string (uuid)
The work unit.
import_idalways sent string (uuid)
The import.
import_typealways sent stringXLIFF XLSX DOCX
Kind of bilingual file.
is_last_workflow boolean
Whether that step is the last one of the file's workflow.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the project.
project_uuidalways sent string (uuid)
The project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
segments_confirmedalways sent integer (int64)
Segments confirmed by the import.
segments_in_filealways sent integer (int64)
Segments in the imported file.
segments_lockedalways sent integer (int64)
Locked segments left untouched.
segments_updatedalways sent integer (int64)
Segments whose translation changed.
segments_with_tag_problems integer (int64)
Segments whose tags did not match.
segments_without_idalways sent integer (int64)
Segments the file had no id for.
statusalways sent stringNOT_STARTED STARTED IMPORTED ERROR
IMPORTED or ERROR.
workflow string
The workflow step of the work unit, such as TRANSLATION.
Example body
{
  "ci_tag": "string",
  "creation_date": 0,
  "details": {
    "import": {
      "action": "GET",
      "description": "string",
      "url": "string"
    }
  },
  "ending_date": 0,
  "error": "WORK_UNIT_READ_ONLY",
  "event_type": "WORK_UNIT_IMPORT_FINISHED",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "import_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "import_type": "XLIFF",
  "is_last_workflow": false,
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "segments_confirmed": 0,
  "segments_in_file": 0,
  "segments_locked": 0,
  "segments_updated": 0,
  "segments_with_tag_problems": 0,
  "segments_without_id": 0,
  "status": "NOT_STARTED",
  "workflow": "string"
}

POSTWORK_UNIT_STATUS_CHANGE

Work Unit Status Changed

A work unit's status changes.

Body · 26 fields

WorkUnitStatusChangeEvent

begin_indexalways sent integer (int64)
Index of the work unit's first segment.
charsalways sent integer (int64)
Characters in the work unit.
ci_tag string
The CI tag of the event's project, when it has one.
confirmed_non_translatablealways sent integer (int64)
Non-translatable segments confirmed.
confirmed_segmentsalways sent integer (int64)
Segments confirmed so far.
end_indexalways sent integer (int64)
Index of the work unit's last segment.
event_typealways sent stringWORK_UNIT_STATUS_CHANGE
The event's type key, repeated in the details.
extracted_contentalways sent object
Metadata extracted from the source file.
idalways sent string (uuid)
The work unit.
is_last_workflow boolean
Whether that step is the last one of the file's workflow.
new_statusalways sent stringCREATED COPYING_CONTENT CONTENT_READY TRANSLATING TRANSLATION_FAILED TRANSLATED SKIPPED CANCELLED DELIVERED DELIVERED_WAITING_CONFIRMATION EXPIRED UNDER_REVIEW_BY_ADMIN READY_TO_TRANSLATE
Status after the change.
org_unit_uuidalways sent string (uuid)
Org unit (client) of the project.
previous_statusalways sent stringCREATED COPYING_CONTENT CONTENT_READY TRANSLATING TRANSLATION_FAILED TRANSLATED SKIPPED CANCELLED DELIVERED DELIVERED_WAITING_CONFIRMATION EXPIRED UNDER_REVIEW_BY_ADMIN READY_TO_TRANSLATE
Status before the change.
project_file_idalways sent string (uuid)
The project file.
project_file_namealways sent string
Name of the file.
project_step_levelalways sent integer (int64)
Workflow step level; 1 is the first step.
project_uuidalways sent string (uuid)
The project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_localealways sent string
Source language code.
target_localealways sent string
Target language code.
total_non_translatablealways sent integer (int64)
Non-translatable segments in the work unit.
total_segmentsalways sent integer (int64)
Segments in the work unit.
translated_file_urlalways sent string
Link to the translated file, when there is one.
wordsalways sent integer (int64)
Words in the work unit.
workflow string
The workflow step of the work unit, such as TRANSLATION.
Example body
{
  "begin_index": 0,
  "chars": 0,
  "ci_tag": "string",
  "confirmed_non_translatable": 0,
  "confirmed_segments": 0,
  "end_index": 0,
  "event_type": "WORK_UNIT_STATUS_CHANGE",
  "extracted_content": {},
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_last_workflow": false,
  "new_status": "CREATED",
  "org_unit_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "previous_status": "CREATED",
  "project_file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_file_name": "string",
  "project_step_level": 0,
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "target_locale": "string",
  "total_non_translatable": 0,
  "total_segments": 0,
  "translated_file_url": "string",
  "words": 0,
  "workflow": "string"
}

POSTWORK_UNIT_TRANSLATION_FILE_READY

Work Unit Translation File Ready

A work unit's translated file is built and can be downloaded.

Body · 20 fields

WorkUnitTranslationFileReadyEvent

ci_tag string
The CI tag of the event's project, when it has one.
confirmed_segmentsalways sent integer (int64)
Segments confirmed.
details map<string, WebhookApiCall>
download: the call that returns a signed link to the translated file. Left out when the translation failed.
event_typealways sent stringWORK_UNIT_TRANSLATION_FILE_READY
The event's type key, repeated in the details.
extracted_contentalways sent object
Metadata extracted from the source file.
idalways sent string (uuid)
The work unit.
is_last_workflow boolean
Whether that step is the last one of the file's workflow.
original_file_urlalways sent string
Download link of the source file; expires after about 7 days.
project_file_namealways sent string
Name of the file.
project_uuidalways sent string (uuid)
The project.
retryOf string (uuid)
Only on a delivery retried with Retry Webhook Event or from the Events tab: the uuid of the original delivery.
retryRequestedAt integer (int64)
Only on a retried delivery: when the retry was asked for. Unix time in milliseconds.
source_localealways sent string
Source language code.
statusalways sent stringCREATED COPYING_CONTENT CONTENT_READY TRANSLATING TRANSLATION_FAILED TRANSLATED SKIPPED CANCELLED DELIVERED DELIVERED_WAITING_CONFIRMATION EXPIRED UNDER_REVIEW_BY_ADMIN READY_TO_TRANSLATE
Status of the work unit.
target_localealways sent string
Target language code.
total_segmentsalways sent integer (int64)
Segments in the work unit.
translated_file_creation_datealways sent integer (int64)
When the translated file was built. Unix time in milliseconds.
translated_file_urlalways sent string
Download link of the translated file; expires after about 7 days.
translation_statusalways sent stringNOT_TRANSLATED PREPARING TRANSLATED ERROR
Status of the translated file.
workflow string
The workflow step of the work unit, such as TRANSLATION.
Example body
{
  "ci_tag": "string",
  "confirmed_segments": 0,
  "details": {
    "download": {
      "action": "GET",
      "description": "string",
      "url": "string"
    }
  },
  "event_type": "WORK_UNIT_TRANSLATION_FILE_READY",
  "extracted_content": {},
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_last_workflow": false,
  "original_file_url": "string",
  "project_file_name": "string",
  "project_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryOf": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "retryRequestedAt": 0,
  "source_locale": "string",
  "status": "CREATED",
  "target_locale": "string",
  "total_segments": 0,
  "translated_file_creation_date": 0,
  "translated_file_url": "string",
  "translation_status": "NOT_TRANSLATED",
  "workflow": "string"
}