HTTP API & Webhook Gateway

An Apify Actor for making HTTP requests to external APIs. It handles the complexities of network communication, including retries, proxy rotation, and error handling, so you can focus on integrating services.

Overview

This actor is a configurable HTTP client. You define the request (URL, method, headers, data), and it executes it, returning the response. It's useful for API integration, webhook forwarding, automated testing, and data collection tasks where direct HTTP calls from your code are impractical or need enhanced reliability.

Key Features

• Full HTTP Support: All standard methods (GET, POST, PUT, DELETE, PATCH, etc.).
• Flexible Data Handling: Send JSON, form-encoded data, or raw content.
• Robust Execution:
  • Automatic retries with exponential backoff for transient failures.
  • Integrated Apify Proxy support for IP rotation.
  • Configurable timeouts and redirect handling.
• Security: Sensitive data like credentials are not logged.
• Multiple Response Formats: Handles JSON, text, and binary responses.

How to Use

Configure the actor using a JSON input object. Only the url field is strictly required.

Basic Structure

{
  "method": "GET",
  "url": "https://api.example.com/endpoint",
  "headers": {
    "Authorization": "Bearer YOUR_TOKEN"
  },
  "data": { /* Request body for POST/PUT */ },
  "params": { /* URL query parameters */ },
  "retry": { "attempts": 3 },
  "proxySettings": { "useApifyProxy": true }
}

Common Examples

Simple GET Request:

{
  "method": "GET",
  "url": "https://jsonplaceholder.typicode.com/posts/1"
}

POST with JSON Data:

{
  "method": "POST",
  "url": "https://api.example.com/users",
  "headers": { "Content-Type": "application/json" },
  "data": { "name": "John", "email": "john@example.com" }
}

Request with Query Parameters & Retries:

{
  "url": "https://api.example.com/search",
  "params": { "q": "term", "page": 1 },
  "retry": { "attempts": 3, "backoffSeconds": 2 }
}

Input Configuration

Output

The actor returns a JSON object containing the HTTP response and execution details.

{
  "url": "https://api.example.com/data",
  "method": "GET",
  "statusCode": 200,
  "headers": { /* Response headers */ },
  "body": { /* Parsed response body (e.g., JSON) */ },
  "rawBody": "...", // Raw response text
  "retryCount": 0,
  "error": null // Contains error details if the request failed
}

On failure, the error field will contain a message and the statusCode will reflect the HTTP error (e.g., 429, 500). The actor will only throw after exhausting all retry attempts.