rbtools.api.resource.webhook¶

Resource definitions for WebHooks.

Classes

class rbtools.api.resource.webhook.WebHookItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: ItemResource

Item resource for WebHooks.

This corresponds to Review Board’s WebHook Resource.

Added in version 6.0.

__firstlineno__ = 28¶

__static_attributes__ = ()¶

apply_to: Literal['all', 'none', 'custom']¶

What review requests the WebHook applies to.

In the case of custom, the repositories are specified in the repositories field.

custom_content: str¶

An optional custom payload.

enabled: bool¶

Whether or not the WebHook is enabled.

encoding: Literal['application/json', 'application/xml', 'application/x-www-form-urlencoded']¶

The encoding for the payload.

events: list[str]¶

A list of events that will cause the WebHook to trigger.

extra_data: ResourceExtraDataField¶

Extra data as part of the WebHook.

id: int¶

The numeric ID of the WebHook.

repositories: ResourceListField[ResourceLinkField[RepositoryItemResource]]¶

The list of repositories this applies to.

secret: str¶

An optional HMAC digest for the WebHook payload.

If this is specified, the payload will be signed with it.

url: str¶

The URL to make HTTP requests against.

class rbtools.api.resource.webhook.WebHookListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: ListResource[WebHookItemResource]

List resource for WebHooks.

This corresponds to Review Board’s WebHook List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 82¶

__static_attributes__ = ()¶