Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JanCizmar merged 1 commit into from
May 26, 2026
+4 −3
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions platform/projects_and_organizations/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,11 @@ it leads to a `SET_TRANSLATIONS` activity. The `modifiedEntities` would contain
]
```

These operations don't provide all the information about modifications since the amount of changes might be extremely large. You will have to handle such events differently.
For the following activity types, `modifiedEntities` is omitted from the webhook payload because the amount of changes can be extremely large:

`KEY_DELETE`, `IMPORT`, `DELETE_LANGUAGE`, `BATCH_PRE_TRANSLATE_BY_TM`, `BATCH_MACHINE_TRANSLATE`, `AUTO_TRANSLATE`, `BATCH_CLEAR_TRANSLATIONS
BATCH_COPY_TRANSLATIONS`, `BATCH_SET_TRANSLATION_STATE`, `BATCH_TAG_KEYS`, `BATCH_UNTAG_KEYS`, `BATCH_SET_KEYS_NAMESPACE`, `AUTOMATION`, `BATCH_ASSIGN_TRANSLATION_LABEL`, `BATCH_UNASSIGN_TRANSLATION_LABEL`
`KEY_DELETE`, `IMPORT`, `DELETE_LANGUAGE`, `BATCH_PRE_TRANSLATE_BY_TM`, `BATCH_MACHINE_TRANSLATE`, `AUTO_TRANSLATE`, `BATCH_CLEAR_TRANSLATIONS`, `BATCH_COPY_TRANSLATIONS`, `BATCH_SET_TRANSLATION_STATE`, `BATCH_TAG_KEYS`, `BATCH_UNTAG_KEYS`, `BATCH_SET_KEYS_NAMESPACE`, `AUTOMATION`, `BATCH_ASSIGN_TRANSLATION_LABEL`, `BATCH_UNASSIGN_TRANSLATION_LABEL`

To retrieve the modifications for these events, use the `revisionId` from the webhook payload with the [Get modified entities by revision](/api/get-modified-entities-by-revision) endpoint. The response is paginated and supports filtering by entity class (e.g. `Translation`, `Key`). You can also fetch summary information about the revision itself via the [Get single revision](/api/get-single-revision) endpoint.

## Failing webhooks
When the execution fails, the webhook is retried several times. Because of this, it is a good idea to check the timestamp
Expand Down
Loading