<- Back to all posts

Introducing Webhooks: Build custom, automated workflows

Jessica Ouyang
November 9, 2023

Since releasing our developer integrations, teams have used our API, CLI, and SDKs to manage product copy in all stages of the software development lifecycle: updating text locally, integrating our CLI into CI/CD pipelines, integrating with translation and A/B testing tools, and more.

With our API/CLI, up-to-date product copy is available on-demand: whenever a developer fetched the specified text using either our API or CLI. However, as teams built out more complex workflows using Ditto, we wanted to provide developers with a way to gain visibility into actions (text edits, ID edits, status changes) happening in Ditto.

Today, we’re excited to introduce webhooks to our developer tooling!

Webhooks allow developers to get notified about actions in Ditto in real-time. This enables teams to build custom workflows that automatically get triggered by changes in Ditto.

How do Ditto webhooks work?

In simple terms, Ditto Webhooks are real-time notifications sent by Ditto to your application whenever there's a change to data stored in Ditto. This includes notifications for text edits, status changes, ID edits, and more.

Unlike the API and CLI, which fetches information from Ditto when initiated by the user (for example: running our CLI to pull up-to-date text), payloads for Ditto Webhooks are initiated by actions taken in Ditto and contain information about what’s changed.

Webhooks allow you to connect actions in Ditto to all the other tools and systems your team uses.

How can you use Ditto webhooks?

Developers can create webhooks for the actions they want to get notified by in Ditto. Developers are able to get notified the moment a change happens, eliminating manual monitoring on when to implement upstream copy changes.

A few ways you can use webhooks include:

  • Real-time synchronization between Ditto, development, and other platforms: With webhooks, the moment a change is made in Ditto, the new data can instantly be reflected in your application, CMS, CDN, or another tool. This means no manual updates or checks, saving developers time and effort.

    For example: having edits in designs/Ditto get immediately reflected in a localization tool to then be translated.
  • Building automation around Ditto events: Using webhooks, you can build automation and event-driven architecture triggered by actions taken in Ditto. This can include connecting parts of your deployment process to status changes, text edits, and ID changes.

    For example: triggering an update to text in development and a new deploy when text is edited.
  • Visibility and real-time notification to relevant stakeholders: Instead of team members constantly checking for updates, you can set up Ditto webhooks to send instant alerts to the right people when product copy changes. This ensures that everyone is on the same page and can act on the latest information.

    For example: notifying developers when text in Ditto has been compliance-approved and the status has been updated.

Getting Started

To get started with our webhooks, check out our guide in our developer docs, where we cover the basics and step-by-step instructions. (If you’re not a developer but curious if this can help your team’s developer integrations, feel free to reach out!)

We’re so excited for teams to start using Ditto webhooks in their developer toolkit. We hope this helps bridge the gap between how edits to copy move from Ditto and designs into production in a way that’s scalable and robust. If you get to try this out in your own workflow, let us know what you build!

Success! 🥳 Look forward to Ditto updates in your inbox.
Oh no — something went wrong while submitting the form. Please try again!