fix: include all supported fields for ad-hoc webhooks#855
Merged
Conversation
apify-service-account
added
the
t-tooling
Codecov Report❌ Patch coverage is
❌ Your patch check has failed because the patch coverage (41.37%) is below the target coverage (50.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## master #855 +/- ##
==========================================
- Coverage 94.82% 94.51% -0.32%
==========================================
Files 48 48
Lines 5045 5069 +24
==========================================
+ Hits 4784 4791 +7
- Misses 261 278 +17
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
changed the title
vdusek
changed the title
vdusek
added a commit
to apify/apify-docs
that referenced
this pull request
Jun 16, 2026
…ion (#2640) - The `WebhookRepresentation` schema (items of the Base64-encoded `webhooks` query parameter on the run/build endpoints) declared only `eventTypes`, `requestUrl`, `payloadTemplate` and `headersTemplate`, but the platform accepts and honors more fields for ad-hoc webhooks: the run-start handler spreads each webhook object into the same `insertWebhook` path used by the create-webhook endpoint, including the `idempotencyKey` dedup logic. - This adds the missing `idempotencyKey`, `ignoreSslErrors` and `doNotRetry` properties to the schema, so generated API clients (e.g. `apify-client-python`) stop dropping them. - The Python client and SDK changes that build on this: - apify/apify-sdk-python#963 - apify/apify-client-python#855
vdusek
approved these changes
Jun 16, 2026
vdusek
changed the title
vdusek
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the auto-generated Pydantic models and TypedDicts based on OpenAPI specification changes in apify-docs PR #2640.
On top of the regenerated models, it fixes a related bug: ad-hoc webhooks passed to
start()/call()silently droppedidempotency_key,ignore_ssl_errorsanddo_not_retry.WebhookRepresentationdeclared only the four templating fields, andencode_webhooks_to_base64keeps only declared fields, so these three never reached the platform. The platform accepts and honors all three for ad-hoc webhooks (verified in apify-core: the run-start handler feeds them into the same webhook-creation path as the create-webhook endpoint, including theidempotencyKeydedup).What changed:
WebhookRepresentationand both webhook-representation typed dicts (snake_case + camelCase).WebhookCreate/ dict projection inencode_webhooks_to_base64to filter by the fieldsWebhookRepresentationdeclares, instead of hand-listing them. New ad-hoc fields now flow through automatically, so this class of silent-drop bug cannot recur.Supersedes #854 (a manual version of the same fix).
Unblocks apify/apify-sdk-python#963, which forwards these fields from the SDK
Webhookdataclass.