Skip to main content
Version: 0.6

WebhookClient

Sub-client for manipulating a single webhook.

Hierarchy

Index

Methods

Methods

__init__

  • __init__(args, kwargs): None

delete

  • delete(): None

dispatches

get

  • get(): Optional[Dict]

test

  • test(): Optional[Dict]

update

  • update(*, event_types, request_url, payload_template, actor_id, actor_task_id, actor_run_id, ignore_ssl_errors, do_not_retry, is_ad_hoc): Dict

  • Update the webhook.

    https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook

    Parameters

    • optionalkeyword-onlyevent_types: Optional[List[WebhookEventType]] = None

      List of event types that should trigger the webhook. At least one is required.

    • optionalkeyword-onlyrequest_url: Optional[str] = None

      URL that will be invoked once the webhook is triggered.

    • optionalkeyword-onlypayload_template: Optional[str] = None

      Specification of the payload that will be sent to request_url

    • optionalkeyword-onlyactor_id: Optional[str] = None

      Id of the actor whose runs should trigger the webhook.

    • optionalkeyword-onlyactor_task_id: Optional[str] = None

      Id of the actor task whose runs should trigger the webhook.

    • optionalkeyword-onlyactor_run_id: Optional[str] = None

      Id of the actor run which should trigger the webhook.

    • optionalkeyword-onlyignore_ssl_errors: Optional[bool] = None

      Whether the webhook should ignore SSL errors returned by request_url

    • optionalkeyword-onlydo_not_retry: Optional[bool] = None

      Whether the webhook should retry sending the payload to request_url upon failure.

    • optionalkeyword-onlyis_ad_hoc: Optional[bool] = None

      Set to True if you want the webhook to be triggered only the first time the condition is fulfilled. Only applicable when actor_run_id is filled.

    Returns Dict

    dict: The updated webhook

Page Options