firecrawl 1.8.1 → 1.8.3

package/dist/index.cjs

@@ -292,11 +292,12 @@ var FirecrawlApp = class {
    * @param params - Additional parameters for the scrape request.
    * @param pollInterval - Time in seconds for job status checks.
    * @param idempotencyKey - Optional idempotency key for the request.
+   * @param webhook - Optional webhook for the batch scrape.
    * @returns The response from the crawl operation.
    */
-  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey) {
+  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey, webhook) {
     const headers = this.prepareHeaders(idempotencyKey);
-    let jsonData = { urls, ...params ?? {} };
+    let jsonData = { urls, ...params ?? {}, webhook };
     try {
       const response = await this.postRequest(
         this.apiUrl + `/v1/batch/scrape`,

package/dist/index.d.cts

@@ -143,7 +143,10 @@ interface CrawlParams {
     allowExternalLinks?: boolean;
     ignoreSitemap?: boolean;
     scrapeOptions?: CrawlScrapeOptions;
-    webhook?: string;
+    webhook?: string | {
+        url: string;
+        headers?: Record<string, string>;
+    };
     deduplicateSimilarURLs?: boolean;
     ignoreQueryParameters?: boolean;
 }
@@ -300,9 +303,10 @@ declare class FirecrawlApp {
      * @param params - Additional parameters for the scrape request.
      * @param pollInterval - Time in seconds for job status checks.
      * @param idempotencyKey - Optional idempotency key for the request.
+     * @param webhook - Optional webhook for the batch scrape.
      * @returns The response from the crawl operation.
      */
-    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string, webhook?: CrawlParams["webhook"]): Promise<BatchScrapeStatusResponse | ErrorResponse>;
     asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string): Promise<BatchScrapeResponse | ErrorResponse>;
     /**
      * Initiates a batch scrape job and returns a CrawlWatcher to monitor the job via WebSocket.

package/dist/index.d.ts

@@ -143,7 +143,10 @@ interface CrawlParams {
     allowExternalLinks?: boolean;
     ignoreSitemap?: boolean;
     scrapeOptions?: CrawlScrapeOptions;
-    webhook?: string;
+    webhook?: string | {
+        url: string;
+        headers?: Record<string, string>;
+    };
     deduplicateSimilarURLs?: boolean;
     ignoreQueryParameters?: boolean;
 }
@@ -300,9 +303,10 @@ declare class FirecrawlApp {
      * @param params - Additional parameters for the scrape request.
      * @param pollInterval - Time in seconds for job status checks.
      * @param idempotencyKey - Optional idempotency key for the request.
+     * @param webhook - Optional webhook for the batch scrape.
      * @returns The response from the crawl operation.
      */
-    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string, webhook?: CrawlParams["webhook"]): Promise<BatchScrapeStatusResponse | ErrorResponse>;
     asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string): Promise<BatchScrapeResponse | ErrorResponse>;
     /**
      * Initiates a batch scrape job and returns a CrawlWatcher to monitor the job via WebSocket.

package/dist/index.js

@@ -256,11 +256,12 @@ var FirecrawlApp = class {
    * @param params - Additional parameters for the scrape request.
    * @param pollInterval - Time in seconds for job status checks.
    * @param idempotencyKey - Optional idempotency key for the request.
+   * @param webhook - Optional webhook for the batch scrape.
    * @returns The response from the crawl operation.
    */
-  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey) {
+  async batchScrapeUrls(urls, params, pollInterval = 2, idempotencyKey, webhook) {
     const headers = this.prepareHeaders(idempotencyKey);
-    let jsonData = { urls, ...params ?? {} };
+    let jsonData = { urls, ...params ?? {}, webhook };
     try {
       const response = await this.postRequest(
         this.apiUrl + `/v1/batch/scrape`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firecrawl",
-  "version": "1.8.1",
+  "version": "1.8.3",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -153,7 +153,10 @@ export interface CrawlParams {
   allowExternalLinks?: boolean;
   ignoreSitemap?: boolean;
   scrapeOptions?: CrawlScrapeOptions;
-  webhook?: string;
+  webhook?: string | {
+    url: string;
+    headers?: Record<string, string>;
+  };
   deduplicateSimilarURLs?: boolean;
   ignoreQueryParameters?: boolean;
 }
@@ -540,16 +543,18 @@ export default class FirecrawlApp {
    * @param params - Additional parameters for the scrape request.
    * @param pollInterval - Time in seconds for job status checks.
    * @param idempotencyKey - Optional idempotency key for the request.
+   * @param webhook - Optional webhook for the batch scrape.
    * @returns The response from the crawl operation.
    */
   async batchScrapeUrls(
     urls: string[],
     params?: ScrapeParams,
     pollInterval: number = 2,
-    idempotencyKey?: string
+    idempotencyKey?: string,
+    webhook?: CrawlParams["webhook"],
   ): Promise<BatchScrapeStatusResponse | ErrorResponse> {
     const headers = this.prepareHeaders(idempotencyKey);
-    let jsonData: any = { urls, ...(params ?? {}) };
+    let jsonData: any = { urls, ...(params ?? {}), webhook };
     try {
       const response: AxiosResponse = await this.postRequest(
         this.apiUrl + `/v1/batch/scrape`,