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

• event_types
• headers_template
• payload_template
• request_url

Properties

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.

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.