# WebhookRepresentation<!-- -->

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[](#Index)

### Properties

* [do_not_retry](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#do_not_retry)
* [event_types](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#event_types)
* [headers_template](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#headers_template)
* [idempotency_key](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#idempotency_key)
* [ignore_ssl_errors](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#ignore_ssl_errors)
* [model_config](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#model_config)
* [payload_template](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#payload_template)
* [request_url](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#request_url)
* [should_interpolate_strings](https://docs.apify.com/api/client/python/reference/class/WebhookRepresentation.md#should_interpolate_strings)

## Properties<!-- -->[](#Properties)

### [](#do_not_retry)do_not_retry

do_not_retry: bool | None

Flag to skip retrying the webhook request on failure.

### [](#event_types)event_types

event_types: [list](https://docs.apify.com/api/client/python/reference/class/ActorCollectionClient.md#list)\[[WebhookEventType](https://docs.apify.com/api/client/python/reference.md#WebhookEventType)]

### [](#headers_template)headers_template

headers_template: str | None

Optional template for the HTTP headers sent by the webhook.

### [](#idempotency_key)idempotency_key

idempotency_key: str | None

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

### [](#ignore_ssl_errors)ignore_ssl_errors

ignore_ssl_errors: bool | None

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

### [](#model_config)model_config

model_config: Undefined

### [](#payload_template)payload_template

payload_template: str | None

Optional template for the JSON payload sent by the webhook.

### [](#request_url)request_url

request_url: str

The URL to which the webhook sends its payload.

### [](#should_interpolate_strings)should_interpolate_strings

should_interpolate_strings: bool | None

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