{ "openapi": "3.0.1", "info": { "title": "Webhook Event Store", "description": "Webhook Event Store & Replay System\nThe ultimate debugging tool for webhook integrations. Capture, inspect, and replay webhook events from any service.\n\n🎯 What It Does\nWebhook Event Store provides a complete lifecycle management system for webhooks.", "version": "1.0", "x-build-id": "xtjSebdhBmeBOwHcK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fiery_dream~webhook-event-store/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fiery_dream-webhook-event-store", "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/fiery_dream~webhook-event-store/runs": { "post": { "operationId": "runs-sync-fiery_dream-webhook-event-store", "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/fiery_dream~webhook-event-store/run-sync": { "post": { "operationId": "run-sync-fiery_dream-webhook-event-store", "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": { "mode": { "title": "Operation Mode", "enum": [ "demo", "capture", "replay", "query" ], "type": "string", "description": "Choose operation: demo (sample data), capture webhooks, replay events, or query stored events", "default": "demo" }, "captureConfig": { "title": "Capture Configuration", "type": "object", "description": "Settings for webhook capture mode", "properties": { "port": { "type": "number", "title": "Server Port", "description": "Port to listen on for incoming webhooks" }, "captureEndpoint": { "type": "string", "title": "Capture Endpoint Path", "description": "URL path to receive webhooks (e.g., /webhook)" }, "validateSignatures": { "type": "boolean", "title": "Validate Webhook Signatures", "description": "Verify webhook signatures (e.g., Stripe, GitHub)" }, "signatureHeader": { "type": "string", "title": "Signature Header Name", "description": "HTTP header containing signature (e.g., X-Hub-Signature-256)" }, "signatureSecret": { "type": "string", "title": "Webhook Secret", "description": "Secret key for signature validation" }, "maxCaptureMinutes": { "type": "number", "title": "Max Capture Duration (minutes)", "description": "Maximum time to capture webhooks before auto-stopping" }, "autoStop": { "type": "boolean", "title": "Auto-stop After Inactivity", "description": "Stop capturing after 5 minutes of no webhooks" } }, "default": { "port": 3000, "captureEndpoint": "/webhook", "validateSignatures": false, "signatureHeader": "X-Signature", "signatureSecret": "", "maxCaptureMinutes": 60, "autoStop": true } }, "replayConfig": { "title": "Replay Configuration", "type": "object", "description": "Settings for event replay mode", "properties": { "targetUrl": { "type": "string", "title": "Target URL", "description": "Destination endpoint to replay webhooks to" }, "replayAll": { "type": "boolean", "title": "Replay All Events", "description": "Replay all stored events or filter by criteria" }, "eventIds": { "type": "array", "title": "Specific Event IDs", "description": "List of event IDs to replay (if not replaying all)" }, "filterByEventType": { "type": "string", "title": "Filter by Event Type", "description": "Only replay events matching this type (optional)" }, "addReplayHeaders": { "type": "boolean", "title": "Add Replay Headers", "description": "Add X-Webhook-Replay: true header to replayed requests" }, "delayBetweenRequests": { "type": "number", "title": "Delay Between Requests (ms)", "description": "Milliseconds to wait between replays to avoid rate limits" } }, "default": { "targetUrl": "", "replayAll": true, "eventIds": [], "filterByEventType": "", "addReplayHeaders": true, "delayBetweenRequests": 100 } }, "queryConfig": { "title": "Query Configuration", "type": "object", "description": "Settings for querying stored events", "properties": { "filterByEventType": { "type": "string", "title": "Filter by Event Type", "description": "Event type to filter (optional)" }, "filterBySource": { "type": "string", "title": "Filter by Source IP", "description": "Source IP address to filter (optional)" }, "dateFrom": { "type": "string", "title": "Date From (ISO)", "description": "Start date for query (ISO 8601 format, optional)" }, "dateTo": { "type": "string", "title": "Date To (ISO)", "description": "End date for query (ISO 8601 format, optional)" }, "limit": { "type": "number", "title": "Result Limit", "description": "Maximum number of events to return" }, "includePayload": { "type": "boolean", "title": "Include Full Payload", "description": "Include complete webhook payload in results" } }, "default": { "filterByEventType": "", "filterBySource": "", "dateFrom": "", "dateTo": "", "limit": 100, "includePayload": true } }, "storageDatasetId": { "title": "Storage Dataset ID", "type": "string", "description": "Apify dataset ID for storing/retrieving events (leave empty to create new)", "default": "" } } }, "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 } } } } } } } } } }