Apify Webhooks/Webhooks API

openapi: 3.2.0
info:
  title: Apify Webhooks/Webhooks API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: 'The Apify API (version 2) provides programmatic access to the Apify

    platform. The API is organized

    around RESTful

    HTTP endpoints. You can download the complete OpenAPI schema of Apify API in the YAML or JSON formats. The source code is also available on GitHub. All requests and responses (including errors) are encoded in

    JSON format with UTF-8 encoding,

    with a few exceptions that are explicitly described in the reference. To access the API, we recommend using one of our API clients:


    Stable API clients:

    - For Node.js, we recommend the `apify-client` NPM

    package. - For Python, we recommend the `apify-client` PyPI

    package. Experimental API clients:

    - For Java, we recommend the `apify-client` Maven central component. - For Rust, we recommend the `apify-client` crate. - For .NET, we recommend the `apify-client` Nuget package. - For PHP, we recommend the `apify-client` Packagist package. - For Go, we recommend the `apify-client` package. The clients'' functions correspond to the API endpoints and have the same

    parameters. This simplifies development of apps that depend on the Apify

    platform. :::note Important Request Details


    - `Content-Type` header: For requests with a JSON body, you must include the `Content-Type: application/json` header. - Method override: You can override the HTTP method using the `method` query parameter. This is useful for clients that can only send `GET` requests. For example, to call a `POST` endpoint, append `?method=POST` to the URL of your `GET` request. :::


    ## Authentication


    **You can find your API token on the

    Integrations page in the

    Apify Console.**


    To use your token in a request, either:


    - Add the token to your request''s `Authorization` header as `Bearer `. E.g., `Authorization: Bearer xxxxxxx`. More info. (Recommended). - Add it as the `token` parameter to your request URL. (Less secure). Using your token in the request header is more secure than using it as a URL

    parameter because URLs are often stored

    in browser history and server logs. This creates a chance for someone

    unauthorized to access your API token. **Never share your API token or password with untrusted parties!**


    For more information, see our

    integrations documentation. ### Agentic payments


    AI agents can authenticate and pay for Actor runs without an Apify account

    using agentic payments. Instead of an API token, the request carries a

    payment credential that both authorizes and pays for the call. Apify supports

    the x402 protocol

    (`PAYMENT-SIGNATURE` header) and

    Skyfire

    (`skyfire-pay-id` header). ## Basic usage


    To run an Actor, send a POST request to the Run

    Actor endpoint using either the

    Actor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g. `janedoe~my-actor`):


    `https://api.apify.com/v2/actors/[actor_id]/runs`


    If the Actor is not runnable anonymously, you will receive a 401 or 403

    response code. This means you need to add your secret API

    token to the request''s

    `Authorization` header (recommended) or as a

    URL query parameter `?token=[your_token]` (less secure). Optionally, you can include the query parameters described in the Run

    Actor section to customize your

    run. If you''re using Node.js, the best way to run an Actor is using the

    `Apify.call()` method from the Apify

    SDK. It

    runs the Actor using the account you are currently logged into (determined

    by the secret API token). The result is an Actor run

    object and its output (if

    any). A typical workflow is as follows:


    1. Run an Actor or task using the Run

    Actor or Run

    task API endpoints. 2. Monitor the Actor run by periodically polling its progress using the Get

    run API

    endpoint. 3. Fetch the results from the Get

    items API endpoint using the

    `defaultDatasetId`, which you receive in the Run request response. Additional data may be stored in a key-value store. You can fetch them from

    the Get record API endpoint

    using the `defaultKeyValueStoreId` and the store''s `key`. **Note**: Instead of periodic polling, you can also run your

    Actor or

    task

    synchronously.'
  contact: {}
  version: v2-2026-10-08T073338Z
servers:
- url: https://api.apify.com
  variables: {}
security:
- httpBearer: []
- apiKey: []
tags:
- name: Webhooks/Webhooks
  x-displayName: Webhooks
  x-parent-tag-name: Webhooks
  x-legacy-doc-urls:
  - '#/reference/webhooks'
  - '#tag/Webhooks'
  - '#/reference/webhooks/webhook-collection'
  - '#tag/WebhooksWebhook-collection'
  - '#/reference/webhooks/webhook-object'
  - '#tag/WebhooksWebhook-object'
  - '#/reference/webhooks/webhook-test'
  - '#tag/WebhooksWebhook-test'
  - '#/reference/webhooks/dispatches-collection'


# --- truncated at 32 KB (57 KB total) ---
# Full source: https://artifacts.apis.io/apify/openapi/apify-webhooks-webhooks-api-openapi.yml