Skip to content

fix: forward idempotency_key, ignore_ssl_errors and do_not_retry for ad-hoc webhooks#854

Closed
vdusek wants to merge 2 commits into
masterfrom
fix/adhoc-webhook-missing-fields
Closed

fix: forward idempotency_key, ignore_ssl_errors and do_not_retry for ad-hoc webhooks#854
vdusek wants to merge 2 commits into
masterfrom
fix/adhoc-webhook-missing-fields

Conversation

@vdusek

@vdusek vdusek commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Description

Ad-hoc webhooks passed to start() / call() silently dropped idempotency_key, ignore_ssl_errors and do_not_retry. WebhookRepresentation declared only the four templating fields, and encode_webhooks_to_base64 keeps 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 the idempotencyKey dedup).

What changed:

  • Adds the three fields to WebhookRepresentation and both webhook-representation typed dicts (snake_case + camelCase).
  • Reworks the WebhookCreate / dict projection in encode_webhooks_to_base64 to filter by the fields WebhookRepresentation declares, instead of hand-listing them. New ad-hoc fields now flow through automatically, so this class of silent-drop bug cannot recur.

This PR updates the auto-generated Pydantic models and TypedDicts based on OpenAPI specification changes in apify-docs PR #2640.

Supersedes #855 (the auto-regeneration of the same model changes).

Unblocks apify/apify-sdk-python#963, which forwards these fields from the SDK Webhook dataclass.

@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 11, 2026
@vdusek vdusek self-assigned this Jun 11, 2026
@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 43.47826% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.58%. Comparing base (9a953c7) to head (43ae378).
⚠️ Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
src/apify_client/_typeddicts.py 0.00% 12 Missing ⚠️
src/apify_client/_utils.py 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #854      +/-   ##
==========================================
- Coverage   94.82%   94.58%   -0.24%     
==========================================
  Files          48       48              
  Lines        5045     5063      +18     
==========================================
+ Hits         4784     4789       +5     
- Misses        261      274      +13     
Flag Coverage Δ
integration 92.73% <26.08%> (-0.47%) ⬇️
unit 83.33% <43.47%> (-0.20%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek changed the title fix: add idempotency_key, ignore_ssl_errors and do_not_retry to WebhookRepresentation fix: forward idempotency_key, ignore_ssl_errors and do_not_retry for ad-hoc webhooks Jun 16, 2026
@github-actions github-actions Bot added this to the 143rd sprint - Tooling team milestone Jun 16, 2026
@github-actions github-actions Bot added the tested Temporary label used only programatically for some analytics. label Jun 16, 2026
@vdusek vdusek closed this Jun 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. tested Temporary label used only programatically for some analytics.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants