Webhook event types

docs/_data/additional_items.yml

@@ -7,6 +7,8 @@
       path: api-rate-limits
 - title: Proxy support
   path: proxy_support
+- title: Webhook events
+  path: webhook_events
 - title: Contributing
   path: contribution_guide
   sub_paths:

docs/additional_info/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 12.3.0 (19-Mar-2024)
+
+* Our SDK now exports types for [webhook events](https://lokalise.github.io/node-lokalise-api/additional_info/webhook_events).
+
 ## 12.2.1 (13-Mar-2024)
 
 * Expose more types

docs/additional_info/webhook_events.md

@@ -0,0 +1,50 @@
+# Webhook events
+
+If you're working with [webhook events](https://developers.lokalise.com/docs/webhook-events), you take take advantage of the typings from our Node SDK.
+
+For example, when processing `project.key.added` event:
+
+```ts
+import type { WebhookProjectKeyAdded } from "@lokalise/node-api";
+
+const event: WebhookProjectKeyAdded = {
+  // ...
+};
+```
+
+The following types are exported:
+
+```
+WebhookProjectImported
+WebhookProjectExported
+WebhookProjectCopied
+WebhookProjectDeleted
+WebhookProjectSnapshotCreated
+WebhookProjectBranchAdded
+WebhookProjectBranchDeleted
+WebhookProjectBranchMerged
+WebhookProjectLanguagesAdded
+WebhookProjectLanguageRemoved
+WebhookProjectLanguageSettingsChanged
+WebhookProjectKeyAdded
+WebhookProjectKeysAdded
+WebhookProjectKeyModified
+WebhookProjectKeysModified
+WebhookProjectKeysDeleted
+WebhookProjectKeyCommentAdded
+WebhookProjectTranslationUpdated
+WebhookProjectTranslationsUpdated
+WebhookProjectTranslationProofread
+WebhookProjectContributorAdded
+WebhookProjectContributorAddedPublic
+WebhookProjectContributorDeleted
+WebhookProjectTaskCreated
+WebhookProjectTaskQueued
+WebhookProjectTaskClosed
+WebhookProjectTaskDeleted
+WebhookProjectTaskLanguageClosed
+WebhookProjectTaskInitialTmLeverageCalculated
+WebhookTeamOrderCreated
+WebhookTeamOrderDeleted
+WebhookTeamOrderCompleted
+```