Pricing

from $8.00 / 1,000 integration runs

Try for free

Go to Apify Store

Laravel Integration

Try for free

Laravel Integration connects Laravel apps with Apify to run Actors, process trigger datasets, send signed webhook callbacks, forward dataset IDs, and support scraper orchestration, queue workflows, and Actor chaining.

Pricing

from $8.00 / 1,000 integration runs

Rating

5.0

(2)

Developer

Sovanza

Actor stats

Bookmarked

Total users

Monthly active users

15 days ago

Last modified

Categories

Developer tools

Automation

Integrations

You can access the Laravel Integration programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

Python

JavaScript

CLI

OpenAPI

HTTP

MCP

{
  "openapi": "3.0.1",
  "info": {
    "version": "0.0",
    "x-build-id": "QNnjjOIhdkQWrKnUe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sovanza.inc~laravel-integration/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sovanza.inc-laravel-integration",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/sovanza.inc~laravel-integration/runs": {
      "post": {
        "operationId": "runs-sync-sovanza.inc-laravel-integration",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/sovanza.inc~laravel-integration/run-sync": {
      "post": {
        "operationId": "run-sync-sovanza.inc-laravel-integration",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "runHealthCheckOnStart": {
            "title": "Run health-check demo on start",
            "type": "boolean",
            "description": "If true, writes one demo dataset row and exits (Apify Console Try actor / CI validation). If false, executes the selected integration mode.",
            "default": false
          },
          "mode": {
            "title": "Integration mode",
            "enum": [
              "run_actor",
              "process_trigger",
              "forward_dataset"
            ],
            "type": "string",
            "description": "run_actor: call another Apify Actor with parameters from Laravel. process_trigger: read dataset items from an integration trigger payload and copy them to this run's dataset. forward_dataset: POST dataset metadata (and optional preview) to your Laravel webhook.",
            "default": "run_actor"
          },
          "laravelWebhookUrl": {
            "title": "Laravel webhook URL",
            "type": "string",
            "description": "HTTPS endpoint on your Laravel app that receives run progress and completion callbacks (e.g. https://your-app.test/api/apify/webhook)."
          },
          "laravelBaseUrl": {
            "title": "Laravel base URL",
            "type": "string",
            "description": "Base URL of your Laravel application (included in callback payloads for traceability)."
          },
          "laravelQueue": {
            "title": "Laravel queue name",
            "type": "string",
            "description": "Queue connection name your Laravel app should use when dispatching jobs from the webhook (passed in callback payload).",
            "default": "default"
          },
          "correlationId": {
            "title": "Correlation ID",
            "type": "string",
            "description": "Optional ID from your Laravel request/job so callbacks can be matched to the originating job."
          },
          "targetActorId": {
            "title": "Target Actor ID",
            "type": "string",
            "description": "Apify Actor ID or username/actor-name to run when mode=run_actor (e.g. sovanza.inc/python-scraper or YOUR_USER/my-scraper)."
          },
          "startUrls": {
            "title": "Start URLs (shortcut)",
            "type": "array",
            "description": "Shortcut for python-scraper when mode=run_actor. Merged into targetActorInput.startUrls. No cookies required.",
            "items": {
              "type": "string"
            }
          },
          "targetActorInput": {
            "title": "Target Actor input (JSON)",
            "type": "object",
            "description": "Full input object passed to the target Actor. Default targets python-scraper (startUrls). For other Actors put their required fields here or use top-level shortcut fields."
          },
          "waitForFinish": {
            "title": "Wait for target Actor to finish",
            "type": "boolean",
            "description": "If true, blocks until the target Actor run completes (up to waitSecs). If false, starts the run and returns immediately.",
            "default": true
          },
          "waitSecs": {
            "title": "Wait timeout (seconds)",
            "minimum": 0,
            "maximum": 3600,
            "type": "integer",
            "description": "Maximum seconds to wait for the target Actor when waitForFinish is true.",
            "default": 300
          },
          "pushResultsToLaravel": {
            "title": "Push final results to Laravel",
            "type": "boolean",
            "description": "Send a final SUCCEEDED callback to laravelWebhookUrl when the run completes successfully.",
            "default": true
          },
          "callbackOnProgress": {
            "title": "Callback on progress",
            "type": "boolean",
            "description": "Send STARTED/PROCESSING callbacks during long operations.",
            "default": true
          },
          "includeDatasetPreviewInCallback": {
            "title": "Include dataset preview in callback",
            "type": "boolean",
            "description": "Attach up to maxCallbackItems rows from the result dataset in the final Laravel callback.",
            "default": false
          },
          "maxCallbackItems": {
            "title": "Max items in callback preview",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum dataset rows to include in Laravel callback payloads when preview is enabled.",
            "default": 50
          },
          "maxDatasetItems": {
            "title": "Max dataset items to process",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "When mode=process_trigger, maximum number of source dataset rows to read and copy.",
            "default": 1000
          },
          "datasetBatchSize": {
            "title": "Dataset batch size",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Number of dataset items fetched per batch when processing trigger datasets.",
            "default": 100
          },
          "mergeProxyIntoTargetActor": {
            "title": "Merge proxy into target Actor input",
            "type": "boolean",
            "description": "If true and proxyConfiguration is set, injects it into targetActorInput when the target input does not already define proxyConfiguration.",
            "default": true
          },
          "useDemoFallbackOnPublicActorError": {
            "title": "Demo fallback when public Actors are disabled",
            "type": "boolean",
            "description": "If true and Actor.call fails because your Apify plan cannot run public Actors (e.g. apify/hello-world), writes a demo result row instead of failing. Use your own username/actor-name in production.",
            "default": true
          },
          "maxRetries": {
            "title": "Max retries",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Retry count for Actor calls and Laravel webhook requests.",
            "default": 3
          },
          "retryDelayMs": {
            "title": "Retry delay (ms)",
            "minimum": 100,
            "maximum": 60000,
            "type": "integer",
            "description": "Base delay between retries (multiplied by attempt number).",
            "default": 1000
          },
          "sourceDatasetId": {
            "title": "Source dataset ID (advanced)",
            "type": "string",
            "description": "Override dataset ID. When empty, the Actor reads payload.resource.defaultDatasetId from Apify integration triggers automatically."
          },
          "sourceKeyValueStoreId": {
            "title": "Source key-value store ID (advanced)",
            "type": "string",
            "description": "Override KV store ID from trigger payload (payload.resource.defaultKeyValueStoreId)."
          },
          "sourceRunId": {
            "title": "Source run ID (advanced)",
            "type": "string",
            "description": "Override triggering run ID (payload.resource.id)."
          },
          "laravelWebhookSecret": {
            "title": "Laravel webhook secret (optional)",
            "type": "string",
            "description": "Shared secret used to sign callbacks with X-Apify-Signature (HMAC SHA-256). Store the same value in Laravel as APIFY_WEBHOOK_SECRET. Stored as a secret input and never written to the dataset."
          },
          "laravelApiToken": {
            "title": "Laravel API token (optional)",
            "type": "string",
            "description": "Optional Bearer token sent as Authorization header when calling your Laravel webhook. Stored as a secret input."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify proxy settings forwarded to child Actors when mergeProxyIntoTargetActor is enabled.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "US"
            }
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Laravel Integration OpenAPI definition

OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.

OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.

By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.

You can download the OpenAPI definitions for Laravel Integration from the options below:

OpenAPI.json

If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.

You can also check out our other API clients:

Laravel Integration API in Python

Laravel Integration API in JavaScript

Laravel Integration API through CLI

Laravel Integration API

🎉 Apify Actors

prog-party/apify-actors

This Apify Actors Actor retrieves data from Apify, allowing to filter, and returns a list of actors as a Dataset.

Prog Party

Send Email

apify/send-mail

Send a custom email to one or more recipients. This Actor is useful for notifications and reporting. It can be invoked directly from code or via webhook integration after another Actor finishes.

Apify

3.3K

5.0

Apify Run Queue

lexis-solutions/apify-run-queue

Apify utility to queue runs until memory is available. Workaround to memory exceeded errors on Apify. This actor will retry starting actor starts with a delay. Open source and free!

Lexis Solutions

5.0

PGVector Integration

apify/pgvector-integration

This integration transfers data from Apify Actors to a Postgres SQL database (with PGVector extension).

Apify

4.6

Facebook Post Scraper | Webhook Support

devninja/facebook-post-scraper-webhook-support

This actor helps you collect Facebook posts quickly. You can set it to run automatically (every hour, day, or month) through Apify Schedule, and it will send the collected data straight to your server using a webhook—no need to check manually.

Devinja

5.0

Webhook API

vivid_astronaut/webhook

Fabio Suizu

RabbitMQ Integration

brasil-scrapers/rabbitmq-integration

This integration processes data from an Apify dataset and delivers it to a RabbitMQ queue. It is configured via a schema that includes details about the dataset and RabbitMQ connection settings.

Brasil Scrapers

OpenAI Vector Store Integration

jiri.spilka/openai-vector-store-integration

This integration uploads data from Apify Actors to the OpenAI Vector Store linked to OpenAI Assistant.

Jiří Spilka

224

4.8

Pinecone Integration

apify/pinecone-integration

This integration transfers data from Apify Actors to a Pinecone and is a good starting point for a question-answering, search, or RAG use case.

Apify

555

3.2

Forward dataset as POST data

anchor/forward-dataset-webhook

This actor forwards the results of an Actor to an endpoint, instead of having to fetch the results manually. It will download the dataset and attach it to the body of a POST request you will specify. It acts as a new webhook. Simplify your Actor process !!!