Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -179,13 +179,19 @@ webhooks:
in: query
description: |
Specifies optional webhooks associated with the Actor run, which can be used to receive a notification
e.g. when the Actor finished or failed. The value is a Base64-encoded
JSON array of objects defining the webhooks. For more information, see
e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array whose items follow
the WebhookRepresentation schema. For more information, see
[Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
style: form
explode: true
schema:
type: string
contentEncoding: base64
contentMediaType: application/json
contentSchema:
type: array
items:
$ref: ../schemas/webhooks/WebhookRepresentation.yaml
example: dGhpcyBpcyBqdXN0IGV4YW1wbGUK...

waitForFinishRun:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
title: WebhookRepresentation
description: |
Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the
`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose
items match this schema. Persistent webhook fields (e.g. `condition`) are not used here.
required:
- eventTypes
- requestUrl
type: object
properties:
eventTypes:
type: array
items:
$ref: ./WebhookEventType.yaml
examples:
- [ACTOR.RUN.SUCCEEDED]
requestUrl:
type: string
description: The URL to which the webhook sends its payload.
examples: ["http://example.com/"]
payloadTemplate:
type: [string, "null"]
description: Optional template for the JSON payload sent by the webhook.
examples: ['{\n "userId": {{userId}}...']
headersTemplate:
type: [string, "null"]
description: Optional template for the HTTP headers sent by the webhook.
examples: ['{\n "Authorization": "Bearer ..."}']