Skip to content

GenericWebhook

Source code in docs_src/capo_devops_agent/types/generic_webhook.py
class GenericWebhook(TypedDict, closed=True):
    webhook_url: NotRequired["str"]
    """<p>The webhook URL endpoint</p>"""
    webhook_id: NotRequired["str"]
    """<p>The unique webhook identifier</p>"""
    webhook_type: NotRequired["capo_devops_agent.types.webhook_type.WebhookType"]
    """<p>The webhook authentication type</p>"""
    webhook_secret: NotRequired["capo_devops_agent.types.webhook_secret.WebhookSecret"]
    """<p>The webhook secret for authentication</p>"""
    api_key: NotRequired["capo_devops_agent.types.api_key_value.ApiKeyValue"]
    """<p>API Key for API Key webhook authentication</p>"""

api_key instance-attribute

api_key: NotRequired[ApiKeyValue]

API Key for API Key webhook authentication

webhook_id instance-attribute

webhook_id: NotRequired[str]

The unique webhook identifier

webhook_secret instance-attribute

webhook_secret: NotRequired[WebhookSecret]

The webhook secret for authentication

webhook_type instance-attribute

webhook_type: NotRequired[WebhookType]

The webhook authentication type

webhook_url instance-attribute

webhook_url: NotRequired[str]

The webhook URL endpoint