WebhookClient

apify_client.clients.WebhookClient

Sub-client for manipulating a single webhook.

Index

Methods

• delete
• dispatches
• get
• test
• update

Methods

delete

• delete(): None

• Delete the webhook.

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

  ---

  Returns None

dispatches

• dispatches(): WebhookDispatchCollectionClient

• Get dispatches of the webhook.

  https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection

  ---

  Returns WebhookDispatchCollectionClient

  A client allowing access to dispatches of this webhook using its list method

get

• get(): Optional[Dict]

• Retrieve the webhook.

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

  ---

  Returns Optional[Dict]

  The retrieved webhook, or None if it does not exist

test

• test(): Optional[Dict]

• Test a webhook.

  Creates a webhook dispatch with a dummy payload.

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

  ---

  Returns Optional[Dict]

  The webhook dispatch created by the test

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

  • event_types: Optional[List[WebhookEventType]] = Noneoptionalkeyword-only

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

  • request_url: Optional[str] = Noneoptionalkeyword-only

    URL that will be invoked once the webhook is triggered.

  • payload_template: Optional[str] = Noneoptionalkeyword-only

    Specification of the payload that will be sent to request_url

  • actor_id: Optional[str] = Noneoptionalkeyword-only

    Id of the actor whose runs should trigger the webhook.

  • actor_task_id: Optional[str] = Noneoptionalkeyword-only

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

  • actor_run_id: Optional[str] = Noneoptionalkeyword-only

    Id of the actor run which should trigger the webhook.

  • ignore_ssl_errors: Optional[bool] = Noneoptionalkeyword-only

    Whether the webhook should ignore SSL errors returned by request_url

  • do_not_retry: Optional[bool] = Noneoptionalkeyword-only

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

  • is_ad_hoc: Optional[bool] = Noneoptionalkeyword-only

    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

  The updated webhook