WebhookCollectionClient

Hierarchy

• ResourceCollectionClient
  • WebhookCollectionClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• publicBaseUrl
• resourcePath
• safeId
• url

Methods

• create
• list

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceCollectionClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceCollectionClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceCollectionClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceCollectionClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceCollectionClient.params

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceCollectionClient.publicBaseUrl

inheritedresourcePath

resourcePath: string

Inherited from ResourceCollectionClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceCollectionClient.safeId

inheritedurl

url: string

Inherited from ResourceCollectionClient.url

Methods

create

• create(webhook): Promise<Webhook>

• https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook

  ---

  Parameters

  • optionalwebhook: WebhookUpdateData

  Returns Promise<Webhook>

list

• list(options): PaginatedIterator<Omit<Webhook, payloadTemplate | headersTemplate>>

• https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks

  Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched items in a single API call is limited.

  const paginatedList = await client.list(options);

  Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are retrieved.

  for await (const singleItem of client.list(options)) {...}

  ---

  Parameters

  • options: WebhookCollectionListOptions = {}

  Returns PaginatedIterator<Omit<Webhook, payloadTemplate | headersTemplate>>