HTTP API & Webhook Gateway
Pricing
$5.00 / 1,000 results
Go to Apify Store
HTTP API & Webhook Gateway
A versatile actor that functions as both a powerful HTTP client and a secure webhook receiver. If your application can trigger an Apify actor but can't make direct HTTP calls, use this tool to interact with any external API. It also provides a stable endpoint to receive incoming webhooks.
0.0 (0)
Pricing
$5.00 / 1,000 results
0
2
2
Last modified
3 days ago
You can access the HTTP API & Webhook Gateway 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.
{ "openapi": "3.0.1", "info": { "version": "0.0", "x-build-id": "3lW1u7VrpSUy5cQaU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amernas~http-api-webhook-gateway/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amernas-http-api-webhook-gateway", "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/amernas~http-api-webhook-gateway/runs": { "post": { "operationId": "runs-sync-amernas-http-api-webhook-gateway", "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/amernas~http-api-webhook-gateway/run-sync": { "post": { "operationId": "run-sync-amernas-http-api-webhook-gateway", "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": { "method": { "title": "HTTP Method", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD" ], "type": "string", "description": "The HTTP method for the request (GET, POST, PUT, DELETE, PATCH).", "default": "GET" }, "url": { "title": "Target URL", "type": "string", "description": "The complete URL endpoint to send the request to (e.g., https://api.example.com/data)." }, "headers": { "title": "HTTP Headers", "type": "object", "description": "HTTP headers to include with the request (e.g., Authorization, Content-Type, User-Agent).", "default": {} }, "params": { "title": "URL Query Parameters", "type": "object", "description": "Query parameters to append to the URL (e.g., ?page=1&limit=10).", "default": {} }, "data": { "title": "Request Body Data", "type": "object", "description": "Data to send in the request body. Used with POST, PUT, PATCH methods." }, "proxySettings": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the request. Configure Apify proxy or custom proxy.", "default": { "useApifyProxy": false } }, "timeoutSecs": { "title": "Request Timeout (seconds)", "minimum": 1, "maximum": 300, "type": "integer", "description": "Maximum time to wait for the request to complete.", "default": 60 }, "followRedirects": { "title": "Follow Redirects", "type": "boolean", "description": "Whether to automatically follow HTTP redirects (3xx responses).", "default": true }, "bodyMode": { "title": "Request Body Mode", "enum": [ "auto", "json", "form", "raw" ], "type": "string", "description": "How to encode the request body. 'auto' detects based on Content-Type header.", "default": "auto" }, "retry": { "title": "Retry Configuration", "type": "object", "description": "Retry settings for transient failures and 5xx responses.", "properties": { "attempts": { "title": "Retry Attempts", "type": "integer", "description": "Number of retry attempts (including the initial request).", "minimum": 1, "maximum": 10 }, "backoffSeconds": { "title": "Backoff Seconds", "type": "integer", "description": "Base delay between retries in seconds (exponential backoff).", "minimum": 1, "maximum": 60 } }, "default": { "attempts": 1, "backoffSeconds": 1 } }, "verbose": { "title": "Verbose Mode", "type": "boolean", "description": "Enable verbose output for debugging. If false, only essential data is returned.", "default": false } } }, "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 } } } } } } } } }}Call any HTTP API & Receive Webhooks on Apify 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 HTTP API & Webhook Gateway from the options below:
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:
