WebhookClient

@hideconstructor

Hierarchy

• ResourceClient
  • WebhookClient

Index

Constructors

• constructor

Properties

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

Methods

• delete
• dispatches
• get
• test
• update

Constructors

constructor

• new WebhookClient(options: ApiClientSubResourceOptions): WebhookClient

• Overrides ResourceClient.constructor

  Parameters

  • options: ApiClientSubResourceOptions

  Returns WebhookClient

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalid

id?: string

Inherited from ResourceClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

resourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceClient.safeId

url

url: string

Inherited from ResourceClient.url

Methods

delete

• delete(): Promise<void>

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

  ---

  Returns Promise<void>

dispatches

• dispatches(): WebhookDispatchCollectionClient

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

  ---

  Returns WebhookDispatchCollectionClient

get

• get(): Promise<undefined | Webhook>

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

  ---

  Returns Promise<undefined | Webhook>

test

• test(): Promise<undefined | WebhookDispatch>

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

  ---

  Returns Promise<undefined | WebhookDispatch>

update

• update(newFields: WebhookUpdateData): Promise<Webhook>

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

  ---

  Parameters

  • newFields: WebhookUpdateData

  Returns Promise<Webhook>