WebhookRepresentationCamelDict

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

• doNotRetry
• eventTypes
• headersTemplate
• idempotencyKey
• ignoreSslErrors
• payloadTemplate
• requestUrl
• shouldInterpolateStrings

Properties

doNotRetry

doNotRetry: NotRequired[bool | None]

Flag to skip retrying the webhook request on failure.

eventTypes

eventTypes: 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]]

headersTemplate

headersTemplate: NotRequired[str | None]

Optional template for the HTTP headers sent by the webhook.

idempotencyKey

idempotencyKey: NotRequired[str | None]

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

ignoreSslErrors

ignoreSslErrors: NotRequired[bool | None]

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

payloadTemplate

payloadTemplate: NotRequired[str | None]

Optional template for the JSON payload sent by the webhook.

requestUrl

requestUrl: str

The URL to which the webhook sends its payload.

shouldInterpolateStrings

shouldInterpolateStrings: NotRequired[bool | None]

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