Translations
Retrieve a translation
Retrieve a specific translation by resource type, resource ID and locale
GET
/
v2
/
translations
/
{resourceType}
/
{resourceId}
/
{locale}
TypeScript
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.translations.retrieve({
resourceType: "workflow",
resourceId: "welcome-email",
locale: "en_US",
});
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Translations.RetrieveAsync(
resourceType: PathParamResourceType.Workflow,
resourceId: "welcome-email",
locale: "en_US"
);
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
use novu\Models\Operations;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$response = $sdk->translations->retrieve(
resourceType: Operations\PathParamResourceType::Layout,
resourceId: 'welcome-email',
locale: 'en_US'
);
if ($response->translationResponseDto !== null) {
// handle response
}import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.translations.retrieve(resource_type=novu_py.TranslationControllerGetSingleTranslationPathParamResourceType.LAYOUT, resource_id="welcome-email", locale="en_US")
# Handle response
print(res)package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"github.com/novuhq/novu-go/v3/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Translations.Retrieve(ctx, operations.PathParamResourceTypeWorkflow, "welcome-email", "en_US", nil)
if err != nil {
log.Fatal(err)
}
if res.TranslationResponseDto != nil {
// handle response
}
}curl --request GET \
--url https://api.novu.co/v2/translations/{resourceType}/{resourceId}/{locale} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.novu.co/v2/translations/{resourceType}/{resourceId}/{locale}', 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/{resourceType}/{resourceId}/{locale}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v2/translations/{resourceType}/{resourceId}/{locale}")
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{
"resourceId": "welcome-email",
"resourceType": "workflow",
"locale": "en_US",
"content": {
"welcome.title": "Welcome",
"welcome.message": "Hello there!"
},
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}Authorizations
secretKeysecretKey
API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
Headers
A header for idempotency purposes
Path Parameters
Resource type
Available options:
workflow, layout Resource ID
Locale code
Response
Translation found
Resource identifier
Example:
"welcome-email"
Resource type
Available options:
workflow, layout Example:
"workflow"
Locale code
Example:
"en_US"
Translation content as JSON object
Example:
{
"welcome.title": "Welcome",
"welcome.message": "Hello there!"
}
Creation timestamp
Example:
"2024-01-01T00:00:00.000Z"
Last update timestamp
Example:
"2024-01-01T00:00:00.000Z"
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.retrieve({
resourceType: "workflow",
resourceId: "welcome-email",
locale: "en_US",
});
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Translations.RetrieveAsync(
resourceType: PathParamResourceType.Workflow,
resourceId: "welcome-email",
locale: "en_US"
);
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
use novu\Models\Operations;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$response = $sdk->translations->retrieve(
resourceType: Operations\PathParamResourceType::Layout,
resourceId: 'welcome-email',
locale: 'en_US'
);
if ($response->translationResponseDto !== null) {
// handle response
}import novu_py
from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.translations.retrieve(resource_type=novu_py.TranslationControllerGetSingleTranslationPathParamResourceType.LAYOUT, resource_id="welcome-email", locale="en_US")
# Handle response
print(res)package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"github.com/novuhq/novu-go/v3/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Translations.Retrieve(ctx, operations.PathParamResourceTypeWorkflow, "welcome-email", "en_US", nil)
if err != nil {
log.Fatal(err)
}
if res.TranslationResponseDto != nil {
// handle response
}
}curl --request GET \
--url https://api.novu.co/v2/translations/{resourceType}/{resourceId}/{locale} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.novu.co/v2/translations/{resourceType}/{resourceId}/{locale}', 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/{resourceType}/{resourceId}/{locale}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v2/translations/{resourceType}/{resourceId}/{locale}")
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{
"resourceId": "welcome-email",
"resourceType": "workflow",
"locale": "en_US",
"content": {
"welcome.title": "Welcome",
"welcome.message": "Hello there!"
},
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}