Skip to main content
Version: Next

WebhookDispatchClient

Client for managing a specific webhook dispatch.

Webhook dispatches represent individual notifications sent by webhooks. This client provides methods to retrieve details about a specific dispatch.

@example
const client = new ApifyClient({ token: 'my-token' });
const webhookClient = client.webhook('my-webhook-id');

// Get a specific dispatch
const dispatchClient = webhookClient.dispatches().get('dispatch-id');
const dispatch = await dispatchClient.get();
@see

https://docs.apify.com/platform/integrations/webhooks

Hierarchy

  • ResourceClient
    • WebhookDispatchClient

Index

Properties

Methods

Properties

inheritedapifyClient

apifyClient: ApifyClient

inheritedbaseUrl

baseUrl: string

inheritedhttpClient

httpClient: HttpClient

optionalinheritedid

id?: string

optionalinheritedparams

params?: Record<string, unknown>

inheritedpublicBaseUrl

publicBaseUrl: string

inheritedresourcePath

resourcePath: string

optionalinheritedsafeId

safeId?: string

inheritedurl

url: string

Methods

get

Page Options