How to use webhooks? 🔗
You must be subscribed to the Autopilot or higher tier to use webhooks.
Then, navigate to your Project settings -> Weebhooks page to set up your first action.
Tip: Webhooks are also available over Localazy Public API
UI Overview 🔗
Adding a webhook 🔗
When activated (organization is on Autopilot Tier) and there are no webhooks configured, click on the ADD WEBHOOK button.
To add and configure a new webhook, you must fill in a URL you wish to call and specify on which event it should be triggered.
- Endpoint URL (mandatory): Specifies the URL to which the webhook will be sent. It has to be a valid URL and unique across all webhooks for the project.
- Description (optional): A description of the webhook, e.g.
"My webhook". It serves only for your better orientation
- Events switches:
- at least one event switch has to be activated to be able to store a webhook configuration
- it is possible to activate/deactivate multiple event switches (as long as the first condition is met)
- see Webhooks Types for the description of each event
Click the ADD NEW WEBHOOK button when you set up everything to activate your webhook.
Editing a webhook 🔗
You can edit the existing webhooks configuration. The logic is the same as creating a new one (see above).
Webhooks Overview Table 🔗
Once you add your first webhook, you will see a neat table of all created webhooks.
You can add, edit, enable/disable and delete all webhooks one by one or by using batch actions.
Invoking webhooks 🔗
When the specified event occurs, all URLs with the given event configured are called with a
POST request. The header
Content-Type is set to
application/json and in the
JSON structure with additional information is provided. Timeouts are set to 10 seconds. Redirects are enabled.
See Weebhoks API for request details.
Available Webhook Events 🔗
You can choose from the following actions which will trigger the webhook.
Comment Added 🔗
This webhook is triggered when a comment is added to the project.
Content Imported 🔗
This webhook is invoked when importing is finished (e.g., from CLI, Gradle or other). The event is invoked only when there are added, updated, or deprecated keys.
Content Imported Empty 🔗
This webhook is invoked when importing is finished. This event is invoked when the importing has finished with no changes.
Project Published 🔗
This webhook is triggered when the project is successfully published (also applies to release tags)
Tag Promoted 🔗
This webhook is triggered after a release tag gets promoted to another tag.