From bba5e142a5f0c48d92ab4a591a7fe57802a1ef06 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Thu, 11 Jun 2026 15:00:10 +0200 Subject: [PATCH 1/3] fix(openapi): add missing ad-hoc webhook fields to WebhookRepresentation --- .../schemas/webhooks/WebhookRepresentation.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml index d0a7c90c07..70ae89bacd 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml @@ -26,3 +26,15 @@ properties: type: [string, "null"] description: Optional template for the HTTP headers sent by the webhook. examples: ['{\n "Authorization": "Bearer ..."}'] + idempotencyKey: + type: [string, "null"] + description: Optional key that prevents creating duplicate webhooks, e.g. when the run-starting request is retried. + examples: [fdSJmdP3nfs7sfk3y] + ignoreSslErrors: + type: [boolean, "null"] + description: Optional flag to ignore SSL errors when the webhook sends the request. + examples: [false] + doNotRetry: + type: [boolean, "null"] + description: Optional flag to skip retrying the webhook request on failure. + examples: [false] From 63c5594a12100b6bffc2c88ecd3b4bbac79ee682 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 16 Jun 2026 08:30:59 +0200 Subject: [PATCH 2/3] fix(openapi): add shouldInterpolateStrings to WebhookRepresentation --- .../components/schemas/webhooks/WebhookRepresentation.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml index 70ae89bacd..ca01ebfa06 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml @@ -26,6 +26,10 @@ properties: type: [string, "null"] description: Optional template for the HTTP headers sent by the webhook. examples: ['{\n "Authorization": "Bearer ..."}'] + shouldInterpolateStrings: + type: [boolean, "null"] + description: Optional flag to also interpolate `{{...}}` variables inside string values of the payload and headers templates. + examples: [false] idempotencyKey: type: [string, "null"] description: Optional key that prevents creating duplicate webhooks, e.g. when the run-starting request is retried. From fac50a87c6700a0cd8daa21956c7bf3b5aa6a8c8 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 16 Jun 2026 08:33:35 +0200 Subject: [PATCH 3/3] docs(openapi): drop redundant "Optional" from webhook field descriptions --- .../schemas/webhooks/WebhookRepresentation.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml b/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml index ca01ebfa06..a83deb5232 100644 --- a/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml +++ b/apify-api/openapi/components/schemas/webhooks/WebhookRepresentation.yaml @@ -28,17 +28,17 @@ properties: examples: ['{\n "Authorization": "Bearer ..."}'] shouldInterpolateStrings: type: [boolean, "null"] - description: Optional flag to also interpolate `{{...}}` variables inside string values of the payload and headers templates. + description: Flag to also interpolate `{{...}}` variables inside string values of the payload and headers templates. examples: [false] idempotencyKey: type: [string, "null"] - description: Optional key that prevents creating duplicate webhooks, e.g. when the run-starting request is retried. + description: Key that prevents creating duplicate webhooks, e.g. when the run-starting request is retried. examples: [fdSJmdP3nfs7sfk3y] ignoreSslErrors: type: [boolean, "null"] - description: Optional flag to ignore SSL errors when the webhook sends the request. + description: Flag to ignore SSL errors when the webhook sends the request. examples: [false] doNotRetry: type: [boolean, "null"] - description: Optional flag to skip retrying the webhook request on failure. + description: Flag to skip retrying the webhook request on failure. examples: [false]