WebhookRepresentationDict

TypedDict counterpart of WebhookRepresentation for ad-hoc webhooks.

Captures the minimal shape the Apify API actually requires when attaching ad-hoc webhooks to a run: only event_types and request_url are mandatory. Unlike WebhookCreateDict, there is no condition field — the API does not use it for ad-hoc webhooks.

Index

Properties

• event_types
• headers_template
• payload_template
• request_url

Properties

event_types

event_types: list[str]

The list of Actor events that trigger this webhook.

headers_template

headers_template: NotRequired[str | None]

Optional template for the HTTP headers sent by the webhook.

payload_template

payload_template: NotRequired[str | None]

Optional template for the JSON payload sent by the webhook.

request_url

request_url: str

The URL to which the webhook sends its payload.