Webhooks

Localazy authenticates webhook events by including a signature in the request header. This security measure lets you verify that the events were genuinely sent by Localazy rather than a third party. This signature verification is important to implement on your receiving endpoint to ensure the security of your webhook integrations.

How to verify webhook requests? #️⃣

Before you can verify signatures, you need to retrieve your project secret using the webhook secret endoint.

To verify that the request sent is valid (and therefore has not been modified during the transfer) calculate the hash of the request, and compare it with the value stored in the X-Localazy-HMAC header.

Learn more about Localazy Webhooks Security

Webhooks in Localazy are user-defined custom callbacks that trigger when specific actions occur within your Localazy projects.

You can currently hook into five different events:

• comment_added: Triggered when someone adds a comment to your project
• import_finished: Triggered when content importing completes with changes (added, updated, or deprecated keys)
• import_finished_empty: Triggered when importing finishes but no changes occurred
• project_published: Triggered when your project is successfully published
• tag_promoted: Triggered when a release tag is promoted to another tag

Using the @localazy/api-client you can interact with the Localazy API in an easier way. Below is an example for obtaining a list of webhooks.

import { ApiClient } from '@localazy/api-client';

const api = new ApiClient({ authToken: 'project-token' });
const webhooks = await api.webhooks.list({
  project: 'project-id', // or Project object
});

Learn more about the Localazy API client on GitHub

By navigating to the “Webhook Logs” inside the Localazy Developer Console, you’ll find a report detailing your webhook events.

You can review:

• When the webhook was triggered
• Which event triggered it
• Request payload
• URL the webhook was sent to
• Response from the server

This allows you to track which webhooks are active, debug any issues, and view their full history.

In Localazy, you can manage webhooks through both the user interface and the API.

To set up and configure webhooks via the user interface, navigate to your project’s settings and select the “Webhooks” section. From there, you can manage your Webhooks in a user-friendly interface.

Learn more about managing Webhooks

For API-based management, Localazy also provides endpoints that allow you to programmatically create, update, and delete webhooks. Detailed instructions for API are available in the Localazy documentation.