How to Set Requester Language via API and Webhook in BoldDesk
This article explains how to automatically update the requester (contact) language in BoldDesk using ticket webhooks and the Contacts API. BoldDesk supports the requester language condition within ticket webhooks, enabling automated updates to a contact’s language profile. This functionality is ideal for multilingual support environments where requester language should be recognized and updated programmatically.
Prerequisites
Before proceeding, ensure that:
- You have admin or developer access to the BoldDesk portal.
- API authentication (API key or OAuth token) is already configured.
- You understand how to create or edit webhooks in BoldDesk.
Step 1: Create or Update the Ticket Webhook
-
Open Admin → Automation → Webhooks.
-
Create a new webhook or edit an existing one.
-
In the Conditions section, use the newly added condition: Requester Language.
-
Set the desired trigger logic (e.g., “When a ticket is created/updated and requester language is detected”).
Step 2: Configure the Webhook Destination URL
Use the following URL format in your webhook configuration:
https://yourdomain.bolddesk.com/api/v1/contacts/{{ticket.Requester.UserId}}?skipDependencyValidation=true
Important:
Replace yourdomain with your actual BoldDesk portal domain.
This endpoint corresponds to the Edit Contact API.
For reference, explore BoldDesk Edit Contact API.
Step 3: Add the Custom Payload
In the webhook configuration, add the following PUT payload:
{
"fields": {
"languageId": 39
}
}
What is languageId?
languageId corresponds to the BoldDesk internal ID for each supported language. You can retrieve available language IDs through the Languages API or request this from support. To retrieve languageId, use the API code below:
curl -X GET "https://{yourdomain}/api/v1/locales/languages?Filter=English&Page=1&PerPage=10&RequiresCounts=true&OrderBy=name&inclusionIds=1&exclusionIds=2" -H "x-api-key: {yourapikey}"
How It Works
Once configured:
- A ticket is created or updated.
- The webhook fires based on the configured conditions.
- The webhook sends a PUT call to the Contacts API using the requester’s user ID.
- The contact’s language is automatically updated to the specified
languageId.
This ensures consistent localization for emails, UI experiences, and automated workflows.
Example Workflow Scenario
- A ticket arrives via email in French.
- Automation identifies the language.
- Webhook triggers and updates the contact’s language to French (e.g.,
languageId = 39). - All future notifications for this contact are sent in French.
Best Practices
- Use sandbox environments to test webhooks before enabling them in production.
- Ensure the webhook is set to PUT method (not POST/GET).
- Validate that “SkipDependencyValidation” is included to prevent validation errors.
- Log webhook responses for debugging (HTTP 200 indicates success).
FAQs
1. How do I find the correct languageId for my portal?
You can retrieve language IDs via:
- The Languages API
2. Can I map requester language automatically from incoming emails?
Yes. If incoming emails contain detectable language metadata, automation rules combined with webhooks can set the appropriate language automatically.
3. Does updating requester language affect historical tickets?
No. Updating a contact’s language only impacts future communication and processes.
4. Can this webhook update other contact fields?
Yes. The same PUT request can include additional fields such as name, phone, or custom fields—provided they are allowed in the Contacts API.
5. Will this process work with third‑party integrations?
Yes. As long as your system triggers the webhook and sends a valid PUT request to the Contacts API, it will update the contact regardless of the originating system.
6. Do I need developer skills to configure this?
Only basic familiarity with APIs and webhook configuration. No advanced programming is required.
7. What if the webhook fails?
Check:
- The authentication method
- Whether the destination URL domain is correct
- Response logs (e.g., 400 or 401 errors)
Contact BoldDesk support if needed.