WebhookRepresentationDict

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.

Index

Properties

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

Properties

do_not_retry

do_not_retry: NotRequired[bool | None]

Flag to skip retrying the webhook request on failure.

event_types

event_types: list[Literal[ACTOR.BUILD.ABORTED, ACTOR.BUILD.CREATED, ACTOR.BUILD.FAILED, ACTOR.BUILD.SUCCEEDED, ACTOR.BUILD.TIMED_OUT, ACTOR.RUN.ABORTED, ACTOR.RUN.CREATED, ACTOR.RUN.FAILED, ACTOR.RUN.RESURRECTED, ACTOR.RUN.SUCCEEDED, ACTOR.RUN.TIMED_OUT, TEST]]

headers_template

headers_template: NotRequired[str | None]

Optional template for the HTTP headers sent by the webhook.

idempotency_key

idempotency_key: NotRequired[str | None]

Key that prevents creating duplicate webhooks, e.g. when the run-starting request is retried.

ignore_ssl_errors

ignore_ssl_errors: NotRequired[bool | None]

Flag to ignore SSL errors when the webhook sends the request.

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.

should_interpolate_strings

should_interpolate_strings: NotRequired[bool | None]

Flag to also interpolate {{...}} variables inside string values of the payload and headers templates.