Team
Shared credential for production and unattended runs.
Connect Apify with Hookshot™ and your stack
Apify is a platform for building, deploying, and managing web scraping and automation tools, known as Actors.
Tools and triggers
What Agents can do in Apify
Available tools and events after Apify is connected.
-
Abort Actor Build
Tool to abort an Actor build that is starting or running. Use when you need to cancel a build in progress. Builds in terminal states (FINISHED, FAILED, ABORTING, TIMED-OUT) are not affected.
-
Abort Actor Run
Tool to abort a running or starting Actor run. Use when you need to stop an Actor run that is currently in STARTING or RUNNING status. For runs with status FINISHED, FAILED, ABORTING, and TIMED-OUT this call does…
-
Add Request to Queue
Tool to add a request to the queue. Use when you need to add a web page URL to a request queue for crawling. If a request with the same uniqueKey was already present in the queue, returns the ID of the existing request.
-
Batch Add Requests to Queue
Tool to batch-add up to 25 requests to a request queue. Use when you need to add multiple requests efficiently. Failed requests due to rate limits should be retried with exponential backoff.
-
Batch Delete Requests From Queue
Tool to batch-delete up to 25 requests from a queue. Use when you need to remove multiple requests efficiently. Failed requests due to rate limits should be retried with exponential backoff.
-
Build Actor
Tool to build an Actor with specified configuration. Use when you need to create a new build of an Actor with a specific version. The build process compiles the Actor's source code into a Docker image.
-
Check Key-Value Store Record Exists
Tool to check if a record exists in a key-value store. Use when you need to verify whether a specific key exists in an Apify Key-Value Store without retrieving its content.
-
Create Actor
Tool to create a new Actor with specified configuration. Use when you need to initialize a fresh Actor programmatically before publishing or running it.
-
Create Actor Task
Tool to create a new Actor task with specified settings. Use when you need to configure or schedule recurring Actor runs programmatically.
-
Create Actor Version
Tool to create a new version of an Actor. Use when you need to add a new version with specific source code location and configuration. Requires versionNumber and sourceType parameters, plus conditional parameters based…
-
Create Actor Version Environment Variable
Tool to create an environment variable for a specific Actor version. Use when adding new environment variables to Actor versions. Requires name and value parameters.
-
Create Dataset
Tool to create a new dataset. Use when you need to initialize or retrieve a dataset by name.
-
Create Key-Value Store
Tool to create a new key-value store or retrieve an existing one by name. Use when you need to initialize a store for saving data records or files. If a store with the given name already exists, returns that store…
-
Create Request Queue
Tool to create a new request queue or retrieve an existing one by name. Use when you need to initialize a queue for storing and managing web scraping requests. If a queue with the given name already exists, returns…
-
Create Schedule
Tool to create a new schedule with specified settings. Use when you need to automate Actor or Actor task execution at specific times using cron expressions.
-
Create Task Webhook
Tool to create a webhook for an Actor task. Use when you need external notifications about task run events (e.g., completion or failure) in downstream systems.
-
Delete Actor
Tool to delete an Actor permanently. Use when you need to remove an Actor by its ID or username~actorName. Confirm before calling.
-
Delete Actor Build
Tool to delete an Actor build permanently. Use when you need to remove a specific build by its ID. The default build for an Actor cannot be deleted. Only users with build permissions can delete builds.
-
Delete Actor Run
Tool to delete a finished Actor run. Use when you need to permanently remove a completed run. Only finished runs can be deleted by the initiating user or organization.
-
Delete Actor Task
Tool to delete an Actor task permanently. Use when you need to remove a task by its ID or username~taskName. Confirm before calling.
-
Delete Actor Version
Tool to delete a specific version of an Actor's source code. Use when you need to remove an Actor version by actor ID and version number. Confirm before calling.
-
Delete Actor Version Environment Variable
Tool to delete an environment variable from a specific Actor version. Use when removing environment variables from Actor versions.
-
Delete Dataset
Tool to delete a dataset permanently. Use when you need to remove a dataset by its ID or username~dataset-name. Confirm before calling.
-
Delete Key-Value Store
Tool to delete a key-value store permanently. Use when you need to remove a key-value store by its ID. Confirm before calling.
-
Delete Key-Value Store Record
Tool to delete a record from a key-value store. Use when you need to remove a specific record by its key from an Apify Key-Value Store.
-
Delete Request From Queue
Tool to delete a specific request from a request queue. Use when you need to remove a request by its ID from an Apify request queue.
-
Delete Request Lock
Tool to delete a request lock from a request queue. Use when you need to unlock a previously locked request. Only the client that locked the request can delete its lock.
-
Delete Request Queue
Tool to delete a request queue permanently. Use when you need to remove a request queue by its ID.
-
Delete Schedule
Tool to delete a schedule by its ID. Use when you need to remove a schedule from the Apify system.
-
Delete Webhook
Tool to delete a webhook by its ID. Use when removing a webhook after confirming the webhook ID.
-
Get Account Limits
Tool to get a complete summary of account limits and usage. Use when you need to retrieve information about usage cycles, spending caps, compute resources, data transfer quotas, and other account limits. This shows the…
-
Get Actor Build
Tool to get detailed information about a specific Actor build. Use when you need to retrieve complete build details by build ID. Optionally wait for the build to finish using the waitForFinish parameter to avoid polling.
-
Get Actor Build Log
Tool to retrieve the log file for a specific Actor build. Use when you need to inspect logs generated during an Actor build process. Only the trailing 5 million characters of the log are stored.
-
Get Actor Details
Tool to get details of a specific Actor. Use when you need actor metadata by ID or username/actorName. Response includes `isDeprecated` and `notice` fields indicating deprecation status, and `pricingInfos` for per-unit…
-
Get Actor Last Run Dataset Items
Tool to get dataset items from the last run of an Actor. Use when you need to retrieve output data from the most recent Actor execution, optionally filtered by run status (e.g., status='SUCCEEDED' to get items only…
-
Get Actor Run
Tool to get details about a specific Actor run. Use when you need to retrieve comprehensive information about a run including its execution status, resource usage, storage IDs, and metadata.
-
Get Actor Task
Tool to get complete details about an Actor task. Use when you need to retrieve task configuration, input settings, or metadata by task ID or username~task-name.
-
Get Actor Version
Tool to get details about a specific version of an Actor. Use when you need version metadata including source type, build tag, and configuration details.
-
Get Actor Version Environment Variable
Tool to get environment variable details for a specific Actor version. Use when retrieving environment variable information from an Actor version. Returns name, value (if not secret), and secret status.
-
Get All Webhooks
Tool to get a list of all webhooks created by the user. Use when you need to enumerate webhooks before filtering or maintenance.
-
Get Current User Account Data
Tool to get private user account information. Use when you need to retrieve comprehensive data about the current user identified by the authentication token, including profile, subscription plan, and proxy settings…
-
Get Dataset
Tool to retrieve dataset metadata by dataset ID. Use when you need information about a dataset's structure, item counts, or access URLs. This does not return dataset items themselves.
-
Get Dataset Items
Tool to retrieve items from a dataset. Use when you need to fetch data from a specified dataset by pagination or filtering. Only JSON format is fully supported. For datasets larger than 1000 items, issue multiple calls…
-
Get Dataset Statistics
Tool to get dataset field statistics by dataset ID. Use when you need statistical information about dataset fields including min, max, null count, and empty count. Only provides field statistics when dataset schema is…
-
Get Default Build
Tool to get the default build for an Actor. Use after specifying the Actor ID; optionally wait for the build to finish before returning.
-
Get Head and Lock Queue Requests
Tool to get and lock head requests from the queue. Returns the given number of first requests from the queue and locks them for the given time, preventing other clients from accessing them during the lock period. Use…
-
Get Key-Value Record
Tool to retrieve a record from a key-value store. Use when you need to fetch a specific value by key from an Apify Key-Value Store.
-
Get Key-Value Store
Tool to retrieve key-value store metadata by store ID. Use when you need detailed information about a specific key-value store including stats and access URLs.
-
Get Key-Value Store Keys
Tool to retrieve a list of keys from a key-value store. Use when you need to list keys in a store with optional filtering and pagination support.
-
Get Last Actor Run
Tool to get the most recent run of a specific Actor. Use when you need to retrieve the last execution details of an Actor and optionally filter by status (e.g., status='SUCCEEDED' to get only the last successful run).
-
Get Last Actor Task Run
Tool to get the most recent run of a specific Actor task. Use when you need to retrieve the last execution details. You can filter by status to get only successful runs using status='SUCCEEDED'.
-
Get List of Actor Version Environment Variables
Tool to get the list of environment variables for a specific Actor version. Use when you need to retrieve environment variable configurations for an Actor version.
-
Get List of Actor Versions
Tool to get the list of versions of a specific Actor. Use when you need to retrieve version metadata including source type, version number, and configuration details.
-
Get List of Actor Webhooks
Tool to get a list of webhooks for a specific Actor. Use when you need to review or manage webhooks configured for an Actor.
-
Get List of Actors
Tool to get the list of all Actors that the user created or used. Use when you need to enumerate or browse Actors. Add my=1 to get only user-created Actors.
-
Get List of Actors in Store
Tool to get list of public Actors from Apify Store. Use when you need to browse or search public Actors available in the store. Supports searching by title, name, description, username, and readme.
-
Get List of Builds
Tool to get a list of builds for a specific Actor. Use when you need paginated access to an Actor’s build (version) history.
-
Get List of Datasets
Tool to get list of datasets for a user. Use when you need to enumerate or browse user's datasets. Supports pagination with up to 1000 items per page.
-
Get List of Key-Value Stores
Tool to get the list of key-value stores owned by the user. Use when you need to enumerate or browse available stores. Supports pagination up to 1000 records per request.
-
Get List of Request Queues
Tool to get list of request queues for a user. Use when you need to enumerate or browse user's request queues. Supports pagination with up to 1000 items per page.
-
Get List of Runs
Tool to get a list of runs for a specific Actor. Use when you need to paginate through runs and optionally filter by status before processing run data.
-
Get List of Schedules
Tool to get list of schedules created by the user. Use when you need to browse or enumerate user's schedules. Supports pagination with up to 1000 items per page.
-
Get List of Task Runs
Tool to get a list of runs for a specific Actor task. Use when you need to paginate through task runs and optionally filter by status.
-
Get List of Task Webhooks
Tool to get a list of webhooks for a specific Actor task. Use when you need to review or paginate webhooks after creating or updating a task.
-
Get List of Tasks
Tool to fetch a paginated list of tasks belonging to the authenticated user. Use when you need to browse or sort tasks created by the user.
-
Get List of Webhook Dispatches
Tool to get list of webhook dispatches for the user. Use when you need to retrieve webhook execution history with pagination support.
-
Get Log
Tool to retrieve logs for a specific Actor run or build. Use after a run completes or fails — a run may report success status yet contain only informational messages, making log inspection the only way to confirm…
-
Get Monthly Usage
Tool to get monthly usage summary with daily breakdown. Use when you need detailed usage information including storage, data transfer, and request queue metrics for the current or a specific billing cycle. This shows…
-
Get OpenAPI Definition
Tool to get the OpenAPI definition for a specific Actor build. Use when you need the API schema for code generation or analysis.
-
Get Public User Data
Tool to get public user data. Use when you need to retrieve publicly accessible information about a specific Apify user account, similar to what can be seen on public profile pages. This operation requires no…
-
Get Request From Queue
Tool to retrieve a specific request from a request queue by its ID. Use when you need to get detailed information about a request in an Apify request queue.
-
Get Request Queue
Tool to retrieve request queue metadata by queue ID. Use when you need information about a specific request queue including its statistics and request counts.
-
Get Request Queue Head
Tool to retrieve first requests from the queue for inspection. Use when you need to examine pending requests without locking them.
-
Get Run Dataset Items
Tool to get dataset items from a specific Actor run. Use when you need to retrieve the output data from a completed or running Actor run.
-
Get Schedule
Tool to get schedule details by ID. Use when you need to retrieve comprehensive information about a schedule including cron expression, timezone, actions, and execution times.
-
Get Schedule Log
Tool to get schedule log by ID. Use when you need to retrieve execution history for a schedule, including invocation timestamps and status messages. Returns up to 1000 invocations.
-
Get Task Input
Tool to retrieve the input configuration of a specific task. Use when you need to inspect stored task input before execution or debugging.
-
Get Task Last Run Dataset Items
Tool to get dataset items from the last run of an Actor task. Use when you need to retrieve data from the most recent task execution. Filter by status (e.g., 'SUCCEEDED') to get items from the last successful run only.
-
Get User Builds List
Tool to get a paginated list of all builds for a user. Use when you need to retrieve build history across all actors. Supports pagination up to 1000 records.
-
Get Webhook
Tool to get webhook object with all details. Use when you need to retrieve complete information about a specific webhook by its ID.
-
Get Webhook Dispatch
Tool to get webhook dispatch object with all details. Use when you need to retrieve information about a specific webhook dispatch including its status, event data, and call history.
-
Get Webhook Dispatches
Tool to get list of webhook dispatches for a specific webhook. Use when you need to retrieve dispatch history for a particular webhook with pagination support.
-
List Request Queue Requests
Tool to list requests in a request queue with pagination support. Use when you need to retrieve multiple requests from an Apify request queue.
-
List User Actor Runs
Tool to get a paginated list of all Actor runs for the authenticated user. Use when you need to browse all runs across all actors, optionally filtered by status or date range.
-
Prolong Request Lock
Tool to prolong request lock in a request queue. Use when you need to extend the lock duration on a previously locked request. Only the client that locked the request can prolong its lock.
-
Run Actor Asynchronously
Tool to run a specific Actor asynchronously. Use when you need to trigger an Actor run without waiting for completion and retrieve its run details immediately.
-
Run Actor Sync
Tool to run a specific Actor synchronously with input and return its output record. Use when immediate Actor results are needed; runs may timeout after 300 seconds. To avoid timeouts, scope inputs to specific URLs…
-
Run Actor Sync & Get Dataset Items
Tool to run Actor synchronously and get dataset items. Supports both actors that require input and those that don't. Use when immediate access to Actor results is needed. The run must finish within 300 seconds…
-
Run Actor Sync & Get Dataset Items
Tool to run an Actor synchronously and retrieve its dataset items. Use when immediate access to run results is needed.
-
Run Actor Sync Without Input (GET)
Tool to run a specific Actor synchronously without input and return its output. Use when immediate Actor results are needed without providing input data; the run must finish within 300 seconds otherwise the HTTP…
-
Run Task Asynchronously
Tool to run a specific Actor task asynchronously. Use when you need to trigger a task run without waiting for completion and immediately retrieve its run details.
-
Run Task Sync (GET)
Tool to run a specific task synchronously and return its output. Use when immediate task results are needed with pre-configured settings. The run must finish within 300 seconds otherwise the HTTP request fails with a…
-
Run Task Sync (POST)
Tool to run an Actor task synchronously with input override and return its output. Use when immediate task results are needed with custom input parameters. The run must finish within 300 seconds otherwise the HTTP…
-
Run Task Sync & Get Dataset Items
Tool to run an actor task synchronously and retrieve its dataset items. Use when immediate access to task run results is needed. The run must finish within 300 seconds otherwise the request times out. For large…
-
Run Task Sync with Input Override & Get Dataset Items
Tool to run an actor task synchronously with input overrides and retrieve its dataset items. Use when you need to override task input configuration and get immediate results. The run must finish within 300 seconds…
-
Store Data in Dataset
Tool to store data items in a dataset. Use after collecting data when you want to batch-append or update items in an existing dataset.
-
Store Data in Key-Value Store
Tool to create or update a record in a key-value store. Use after you have the store ID and record key to persist JSON data.
-
Test Webhook
Tool to test a webhook by creating a test dispatch with a dummy payload. Use when you need to verify webhook configuration before production use.
-
Unlock Queue Requests
Tool to unlock requests in a request queue that are currently locked by the client. If the client is within an Actor run, unlocks all requests locked by that specific run plus all requests locked by the same clientKey…
-
Update Account Limits
Tool to update account limits manageable on the Limits page. Use when you need to set or modify the monthly spending cap (maxMonthlyUsageUsd) or data retention period (dataRetentionDays). At least one limit parameter…
-
Update Actor
Tool to update Actor settings using JSON payload. Only specified fields will be updated. Use when you need to modify Actor configuration, make an Actor public, or update version settings.
-
Update Actor Run Status Message
Tool to update the status message of an Actor run. Use when you need to set progress information or status updates that will be displayed in the Apify Console UI during Actor execution.
-
Update Actor Task
Tool to update Actor task settings using JSON payload. Only specified properties are updated; others remain unchanged. Use when you need to modify task configuration, input, or execution options.
-
Update Actor Version
Tool to update an Actor version's configuration and source code. Use when modifying version properties such as buildTag, sourceType, or environment variables. Only specified properties will be updated.
-
Update Actor Version Environment Variable
Tool to update environment variable for a specific Actor version using JSON payload. Only specified fields will be updated. Use when modifying existing environment variables in Actor versions.
-
Update Dataset
Tool to update a dataset's name via JSON payload. Use when you need to rename an existing dataset.
-
Update Key-Value Store
Tool to update a key-value store's properties. Use when renaming or changing access of the store after confirming the store ID.
-
Update Request in Queue
Tool to update a request in a request queue. Use when you need to modify request properties or mark a request as handled by setting handledAt to the current date/time. If handledAt is set, the request will be removed…
-
Update Request Queue
Tool to update request queue name using JSON payload. Use when you need to rename an existing request queue.
-
Update Schedule
Tool to update an existing schedule with new settings. Use when you need to modify schedule properties like cron expression, timezone, enabled status, or actions. Only specified fields are updated; others remain…
-
Update Task Input
Tool to update the input configuration of a specific Actor task. Use when you need to modify a scheduled tasks input before execution.
-
Update Webhook
Tool to update webhook using JSON payload. Only specified properties are updated; others remain unchanged. Use when you need to modify webhook settings like event types, target URL, or other configuration.
Setup
Connect Apify in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
