Webhook

An Apify webhook definition used by the Actor SDK.

The same instance can be passed as an ad-hoc webhook to Actor.start() / Actor.call() or as a persistent webhook to Actor.add_webhook() (the condition.actor_run_id is set automatically to the current run).

Index

Methods

• __post_init__

Properties

• do_not_retry
• event_types
• headers_template
• idempotency_key
• ignore_ssl_errors
• payload_template
• request_url

Methods

__post_init__

• __post_init__(): None

• Returns None

Properties

do_not_retry

do_not_retry: bool | None

Whether to skip retrying the request on failure.

event_types

event_types: list[WebhookEventType]

Events that trigger the webhook.

headers_template

headers_template: str | None

Template for the HTTP headers sent by the webhook.

idempotency_key

idempotency_key: str | None

Key that prevents creating duplicate webhooks.

ignore_ssl_errors

ignore_ssl_errors: bool | None

Whether to ignore SSL errors when sending the request.

payload_template

payload_template: str | None

Template for the JSON payload sent by the webhook.

request_url

request_url: str

URL the webhook sends its payload to.