Translations
Retrieve master translations JSON
Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)
GET
/
v2
/
translations
/
master-json
TypeScript
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.translations.master.retrieve("en_US");
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Translations.Master.RetrieveAsync(locale: "en_US");
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$response = $sdk->translations->master->retrieve(
locale: 'en_US'
);
if ($response->getMasterJsonResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.translations.master.retrieve(locale="en_US")
# Handle response
print(res)package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Translations.Master.Retrieve(ctx, v3.Pointer("en_US"), nil)
if err != nil {
log.Fatal(err)
}
if res.GetMasterJSONResponseDto != nil {
// handle response
}
}curl --request GET \
--url https://api.novu.co/v2/translations/master-json \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.novu.co/v2/translations/master-json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.novu.co/v2/translations/master-json")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v2/translations/master-json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workflows": {
"welcome-email": {
"welcome.title": "Welcome to our platform",
"welcome.message": "Hello there!"
},
"password-reset": {
"reset.title": "Reset your password",
"reset.message": "Click the link to reset"
}
},
"layouts": {
"default-layout": {
"layout.title": "Default layout",
"layout.message": "Hello there!"
}
}
}Authorizations
secretKeysecretKey
API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
Headers
A header for idempotency purposes
Query Parameters
Locale to export. If not provided, exports organization default locale
Response
200 - application/json
Master translations JSON retrieved successfully
All translations for given locale organized by workflow identifier
Example:
{
"welcome-email": {
"welcome.title": "Welcome to our platform",
"welcome.message": "Hello there!"
},
"password-reset": {
"reset.title": "Reset your password",
"reset.message": "Click the link to reset"
}
}
All translations for given locale organized by layout identifier
Example:
{
"default-layout": {
"layout.title": "Default layout",
"layout.message": "Hello there!"
}
}
Was this page helpful?
⌘I
TypeScript
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.translations.master.retrieve("en_US");
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Translations.Master.RetrieveAsync(locale: "en_US");
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$response = $sdk->translations->master->retrieve(
locale: 'en_US'
);
if ($response->getMasterJsonResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.translations.master.retrieve(locale="en_US")
# Handle response
print(res)package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Translations.Master.Retrieve(ctx, v3.Pointer("en_US"), nil)
if err != nil {
log.Fatal(err)
}
if res.GetMasterJSONResponseDto != nil {
// handle response
}
}curl --request GET \
--url https://api.novu.co/v2/translations/master-json \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.novu.co/v2/translations/master-json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.novu.co/v2/translations/master-json")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v2/translations/master-json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workflows": {
"welcome-email": {
"welcome.title": "Welcome to our platform",
"welcome.message": "Hello there!"
},
"password-reset": {
"reset.title": "Reset your password",
"reset.message": "Click the link to reset"
}
},
"layouts": {
"default-layout": {
"layout.title": "Default layout",
"layout.message": "Hello there!"
}
}
}