Skip to content
/
Get status of a task

WebRobot ETL API (1.0.0)

API for managing projects, jobs, datasets, and ETL pipelines on WebRobot.

Authentication

The API uses API Keys for authentication. Include the X-API-Key header in all requests.

Base URL

  • Production: https://api.webrobot.eu/api
  • Development: http://localhost:8020/api

Rate Limiting

Requests are limited to 1000 requests per minute per API key.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
WebRobot Support
support@webrobot.eu
License
Proprietary
Languages
Servers
Mock server
http://docs.webrobot.eu/_mock/openapi/
Production
https://api.webrobot.eu/api/
Local development
http://localhost:8020/api/

Cloud

Operations

Scheduler

Operations

Spark

Operations

Health

Operations

Training

Operations

EAN Plugin

Operations

Jobs

Operations

Remove a job from a project

Request

Remove a job from a project by removing the association.

Warning: The job itself is not deleted, only the association to the project.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID to remove

Example: 210
curl -i -X DELETE \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Job removed from project successfully

Bodyapplication/json
object
Response
application/json
{}

Get status of a task

Request

Returns the current status of a task, including execution details and progress.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Task ID

Example: 1
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1/status \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task status

Bodyapplication/json
statusstring
Enum"PENDING""RUNNING""COMPLETED""FAILED"
progressnumber(float)

Progress percentage (0-100)

Response
application/json
{
  "status": "PENDING",
  "progress": 0.1
}

Webhook to notify job completion

Request

Webhook endpoint called by Spark jobs to notify completion or failure of a job execution.

This endpoint is called automatically by the Spark system when a job terminates (with status RUNNING, COMPLETED or FAILED).

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
Bodyapplication/jsonrequired

Job completion webhook payload

jobIdstring

Jobid

executionIdstring

Executionid

sparkApplicationNamestring

Sparkapplicationname

statusstring

Status

outputDatasetPathstring

Outputdatasetpath

outputDatasetFormatstring

Outputdatasetformat

outputDatasetSchemastring

Outputdatasetschema

durationSecondsinteger(int64)

Durationseconds

recordsProcessedinteger(int64)

Recordsprocessed

recordsOutputinteger(int64)

Recordsoutput

outputFileSizeBytesinteger(int64)

Outputfilesizebytes

partitionsCountinteger(int32)

Partitionscount

driverMemoryUsedBytesinteger(int64)

Drivermemoryusedbytes

executorMemoryUsedBytesinteger(int64)

Executormemoryusedbytes

executorCountinteger(int32)

Executorcount

totalCpuTimeSecondsinteger(int64)

Totalcputimeseconds

errorCountinteger(int32)

Errorcount

warningCountinteger(int32)

Warningcount

errorMessagestring

Errormessage

additionalMetricsobjectwrite-only

Additionalmetrics

startedAtstring

Startedat

completedAtstring

Completedat

sparkUiUrlstring

Sparkuiurl

metricsobjectwrite-only

Metrics

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/completion \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "jobId": "string",
    "executionId": "string",
    "sparkApplicationName": "string",
    "status": "string",
    "outputDatasetPath": "string",
    "outputDatasetFormat": "string",
    "outputDatasetSchema": "string",
    "durationSeconds": 0,
    "recordsProcessed": 0,
    "recordsOutput": 0,
    "outputFileSizeBytes": 0,
    "partitionsCount": 0,
    "driverMemoryUsedBytes": 0,
    "executorMemoryUsedBytes": 0,
    "executorCount": 0,
    "totalCpuTimeSeconds": 0,
    "errorCount": 0,
    "warningCount": 0,
    "errorMessage": "string",
    "additionalMetrics": {
      "property1": {},
      "property2": {}
    },
    "startedAt": "string",
    "completedAt": "string",
    "sparkUiUrl": "string",
    "metrics": {
      "property1": {},
      "property2": {}
    }
  }'

Responses

Webhook processed successfully

Bodyapplication/json
object
Response
application/json
{}

Bootstrap

Operations

Images

Operations

Info

Operations

Query

Operations

Upload

Operations

AI Providers

Operations

Models

Operations

Datasets

Operations

Agents

Operations

Categories

Operations

Test

Operations

Cloud Credentials

Operations

Tasks

Operations

Admin

Operations

ETL Library

Operations

Package

Operations

Plugins

Operations

Projects

Operations

ETL Execution

Operations

Execution

Operations

Webhooks

Operations

Metrics

Operations

getHtml

Request

Security
ApiKeyAuth
Path
protocolstringrequired

HTTP protocol (http or https)

urlstringrequired

URL to fetch HTML content from

curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/html/{url}/{protocol}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodytext/html

getById

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

update

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

Bodyapplication/json
property name*objectadditional property
curl -i -X PUT \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

default response

Bodyapplication/json
Response
application/json
null

delete

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

curl -i -X DELETE \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

findAll

Request

Security
ApiKeyAuth
Path
tablestringrequired
Query
pageinteger(int32)
Default 0
pageSizeinteger(int32)

Number of records per page

Default 50
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}?page=0&pageSize=50' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

insert

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

Bodyapplication/json
property name*objectadditional property
curl -i -X POST \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

default response

Bodyapplication/json
Response
application/json
null

getHealth

Request

Security
ApiKeyAuth
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/health \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

Python Extensions

Operations