Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.optexity.com/llms.txt

Use this file to discover all available pages before exploring further.

Set up callbacks to receive automation results without polling.

​
Overview

Optexity sends HTTP POST requests to your callback URL when automations complete.
EnvironmentConfiguration
LocalLOCAL_CALLBACK_URL environment variable
ProductionSet in dashboard

​
Local Development

Set the environment variable: 
LOCAL_CALLBACK_URL=http://localhost:3000/receive_callback
Requirements:
  • URL must be accessible from the machine running the automation
  • Endpoint must be unauthenticated

​
Production

Configure in the Optexity dashboard:
  • Callback URL must be publicly accessible
  • Supports API key authentication
  • Supports username/password authentication

​
Callback Payload

{
  "task_id": "abc123",
  "recording_id": "rec456",
  "endpoint_name": "login-flow",
  "status": "success",
  "output_data": [
    {"name": "email", "value": "test@example.com"}
  ],
  "error": null,
  "final_screenshot": "base64_encoded_string",
  "downloads": [
    {"url": "signed_url", "filename": "report.pdf"}
  ]
}
FieldTypeDescription
task_idstrUnique task identifier
statusstrqueued, allocated, running, success, failed, cancelled
output_datalistExtracted data objects
errorstr | nullError message if failed
final_screenshotstrBase64 screenshot
downloadslistDownload URLs and filenames

​
Authentication

TypeFields Required
API Keyapi_key
Basic Authusername, password
See Callback Reference for complete schema details.