Back to top image

Smartling Webhooks Overview

 

Smartling Webhooks enable real-time notifications when events occur in your Smartling account. Instead of polling for updates, your applications receive instant HTTP notifications, allowing you to build responsive integrations and automated processes.

What are webhooks?

A webhook is a type of HTTP callback that allows Smartling to send real-time notifications to your server when specific events occur. By configuring a webhook URL and creating event subscriptions, your system can automatically receive and respond to these event notifications without needing to continuously check or poll for updates.

Info: Webhooks are one of several developer tools offered by Smartling to help users create custom integrations and seamlessly integrate Smartling into their existing processes.

Webhooks vs. callbacks

Smartling offers both callbacks and webhooks. Please see Smartling Callbacks for documentation on callbacks.

  • Use callbacks when an API request starts a process that takes time, and you need to be notified once that process is finished. For example, when a source file is uploaded to Smartling via API and you want to be notified when the file is fully translated and published.
  • Use webhooks when you want to receive automatic notifications for recurring events in a consistent format. For example, when you want to be notified each time a translation job is completed in a project.

Why use webhooks?

  • Real-time response: React to events as they happen instead of checking periodically for updates.
  • Automated processes: Build integrations that respond automatically to platform events without manual intervention.
  • Reduced complexity: No need to implement polling logic or manage API rate limits for event detection.

Example use cases

The following are examples of how webhooks can be used in integration scenarios.

Translation process automation:

  • Translation job completed → Automatically download translated files and deploy to your CMS

Issue management integration:

  • Source issue created → Create tickets in your internal bug tracking system
  • Translation issue created → Send notifications to translators or project managers
  • Translation issue resolved → Update status in external workflow tools
     

How webhooks work

  1. Configure a subscription: In your subscription, you specify which events you want to receive notifications about, and where to send them. See Setting up webhook subscriptions for more information.
  2. Event occurs: An action you subscribed to happens in your Smartling project (e.g., a job is completed, an issue is created, etc.).
  3. Smartling checks your webhook subscriptions to see which events you want to receive.
  4. Webhook triggered: When Smartling identifies that a subscribed event has occurred, a webhook notification is triggered. This notification consists of a small JSON payload, which contains all of the relevant information about the event and the Smartling project it occurred in.
  5. HTTP request sent: Smartling sends an HTTP POST request with the event details to your configured endpoint URL.
  6. Your system responds: Your application receives the webhook data and processes it accordingly.
     

Setting up webhook subscriptions

A webhook subscription allows you to select which events you want to receive notifications about, which Smartling projects should be monitored for these events, and which endpoint URL the webhook notifications should be sent to.

Note: A maximum of 20 subscriptions can be created per Smartling account.

Webhook subscriptions can be configured through the Webhook Subscriptions List in the Smartling dashboard, or via the Smartling API.

Info: Webhook subscriptions can be created by Account Owners or Project Managers. For more information about access permissions, visit our technical reference.

Adding webhooks via the Smartling dashboard

Webhooks can be added directly in the Smartling dashboard via the Webhooks Subscription List. This page allows you to view and manage your webhook subscriptions. You can view information including: 

  • Subscribed events: View all events you're monitoring
  • Project scope: See which projects have active webhook subscriptions
  • Endpoint URLs: Manage your webhook destination URLs
  • Status management: Enable or disable webhook subscriptions
  • Activity logs: Monitor webhook delivery status and troubleshoot issues
  • Delivery logs: Review detailed delivery attempts and responses

To learn more see Webhooks Subscription List. 

Adding webhooks via API

Alternatively, you can create webhook subscriptions programmatically via API. For more information, see Configuring Webhooks via the Smartling API.

Tip: Webhooks created via the Smartling API can be viewed and managed from the Webhooks Subscription List in the Smartling dashboard.

Third-party integrations

Additional tools, like Smartling's Zapier app, also utilize webhooks. When users create a new Zap, Zapier automatically adds the relevant webhook subscription to monitor trigger events that activate the Zap.

Webhook event types

Events represent significant occurrences in your Smartling account that trigger webhook notifications. You can subscribe to the following types of events.

Note: There is no limit on the number of event types you can subscribe to. However, a maximum of 10 Smartling projects can be included per subscription.

Smartling webhooks support the following event categories:

  • Files
  • Issues
  • Jobs

Info: For a detailed list of all events you can subscribe to, please visit our Events Catalog.

Links to related articles

Table of Contents