Skip to content

docs: link to get-modified-entities-by-revision endpoint for batch webhooks#1112

Merged
JanCizmar merged 1 commit into
mainfrom
jancizmar/docs-webhook-modified-entities-link
May 26, 2026
Merged

docs: link to get-modified-entities-by-revision endpoint for batch webhooks#1112
JanCizmar merged 1 commit into
mainfrom
jancizmar/docs-webhook-modified-entities-link

Conversation

@JanCizmar
Copy link
Copy Markdown
Member

Summary

  • Reword the section that previously said batch/import/delete activities "have to be handled differently" without explaining how
  • Link the revisionId field from the webhook payload to the Get modified entities by revision and Get single revision endpoints
  • Tidy the activity-type list (missing backtick around `BATCH_CLEAR_TRANSLATIONS` and odd line break)

Why

A user receiving a `BATCH_MACHINE_TRANSLATE` webhook had `modifiedEntities: null` and `counts: { Translation: 2 }` but no way to find out which translations changed. The docs hinted that they needed a different approach but didn't point at the actual endpoint (`/v2/projects/{projectId}/activity/revisions/{revisionId}/modified-entities`), which is exactly what's needed.

Test plan

  • Preview the rendered page locally
  • Verify both `/api/get-modified-entities-by-revision` and `/api/get-single-revision` links resolve

…bhooks

Replace vague "handle such events differently" wording with explicit
guidance on using revisionId with the activity API endpoints to
retrieve modifications for batch operations.
@netlify
Copy link
Copy Markdown

netlify Bot commented May 26, 2026

Deploy Preview for tolgee-docs ready!

Name Link
🔨 Latest commit a9fe5fb
🔍 Latest deploy log https://app.netlify.com/projects/tolgee-docs/deploys/6a15c7eea9b1b80008f57641
😎 Deploy Preview https://deploy-preview-1112--tolgee-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@JanCizmar JanCizmar merged commit f9dc3ec into main May 26, 2026
6 checks passed
@JanCizmar JanCizmar deleted the jancizmar/docs-webhook-modified-entities-link branch May 26, 2026 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant