Crawling Manager API

The Crawling Manager API provides endpoints for scheduling, managing, and monitoring data crawling jobs across various connector types including Google Workspace, OneDrive, SharePoint Online, Slack, and Confluence.

Base URL

All endpoints are prefixed with /api/v1/crawlingManager

Authentication

All endpoints require authentication via Authorization header with valid JWT token. In addition:

Endpoints for one connector check that the caller may manage it: a team connector’s schedule only by an admin, and a personal connector’s only by the person who created it
Admin privileges for DELETE /schedule/all, because it removes the schedules of every connector in the organization, including other members’ personal connectors

Headers:

Authorization: Bearer <jwt_token>

Path Parameters

Endpoints for one connector take two path parameters:

connector — the connector’s type name (for example drive, onedrive or jira). The crawling manager accepts any connector type; it doesn’t keep its own list.
connectorId — the ID of the connector instance. The request is checked against this instance: it must exist (otherwise 404), and the caller must be allowed to manage it (otherwise 403).

Internally, each connector’s schedule is keyed as crawl-{connector}-{connectorId}-{orgId}, with the connector name lowercased and spaces replaced by hyphens. That key is the job ID of a one-time (once) schedule and the id reported for a paused schedule. A repeating schedule’s job ID is the one the job queue (BullMQ) assigns.

API Endpoints

POST /:connector/:connectorId/schedule - Schedule Job

Schedule a new crawling job for a specific connector type.Endpoint: POST /api/v1/crawlingManager/:connector/:connectorId/scheduleParameters:

connector (string, path) - The connector type
connectorId (string, path) - The connector instance ID

Request Body
Success Response
Error Responses

{
  "scheduleConfig": {
    "scheduleType": "daily|weekly|monthly|hourly|custom|once|interval",
    "isEnabled": true,
    "timezone": "UTC",
    // Schedule-specific configuration based on scheduleType
  },
  "priority": 5,          // 1-10, default: 5
  "maxRetries": 3,        // 0-10, default: 3
  "timeout": 300000       // 1000-600000ms, default: 300000 (5 minutes)
}

Schedule Configuration Types:All schedule configurations inherit base properties:

scheduleType (required) - The type of schedule
isEnabled (boolean, default: true) - Whether the schedule is enabled
timezone (string, default: “UTC”) - Timezone for schedule execution

Hourly Schedule:

{
  "scheduleType": "hourly",
  "minute": 0,            // 0-59, required
  "interval": 1,          // 1-24, default: 1 (every X hours)
  "isEnabled": true,
  "timezone": "UTC"
}

Daily Schedule:

{
  "scheduleType": "daily", 
  "hour": 9,              // 0-23, required
  "minute": 0,            // 0-59, required
  "isEnabled": true,
  "timezone": "UTC"
}

Weekly Schedule:

{
  "scheduleType": "weekly",
  "daysOfWeek": [1, 2, 3, 4, 5],  // Array of 0-6 (Sunday-Saturday), min 1 item
  "hour": 9,                      // 0-23, required
  "minute": 0,                    // 0-59, required
  "isEnabled": true,
  "timezone": "UTC"
}

Monthly Schedule:

{
  "scheduleType": "monthly",
  "dayOfMonth": 1,        // 1-31, required
  "hour": 9,              // 0-23, required
  "minute": 0,            // 0-59, required
  "isEnabled": true,
  "timezone": "UTC"
}

Custom Schedule (Cron):

{
  "scheduleType": "custom",
  "cronExpression": "0 9 * * 1-5",  // Required, must match pattern: ^(\S+\s+){4}\S+$
  "description": "Weekdays at 9 AM", // Optional
  "isEnabled": true,
  "timezone": "UTC"
}

Once Schedule:

{
  "scheduleType": "once",
  "scheduledTime": "2024-12-31T23:59:59.000Z",  // ISO 8601 datetime string
  "isEnabled": true,
  "timezone": "UTC"
}

Interval Schedule: the interval goes inside a nested scheduleConfig object.

{
  "scheduleType": "interval",
  "isEnabled": true,
  "scheduleConfig": {
    "intervalMinutes": 60   // 1 to 525600 (one year)
  }
}

Status: 201 Created

{
  "success": true,
  "message": "Crawling job scheduled successfully",
  "data": {
    "jobId": "repeat:3f2b9c…:1705312800000",   // assigned by the job queue; a "once" schedule gets crawl-{connector}-{connectorId}-{orgId}
    "connector": "linear",
    "scheduleConfig": {
      "scheduleType": "daily",
      "hour": 9,
      "minute": 0,
      "isEnabled": true,
      "timezone": "UTC"
    },
    "scheduledAt": "2024-01-15T10:30:00.000Z",
    "connectorId": "6650f1c2a9e4b3d2c1a0f9e8"
  }
}

Errors use the standard error shape (see Error Handling):

400 Bad Request — the body doesn’t match the schema: VALIDATION_ERROR, with a message listing the fields. This includes an interval schedule whose intervalMinutes isn’t a whole number from 1 to 525600.
400 Bad Request — HTTP_BAD_REQUEST with one of these messages:
- “Cannot schedule a disabled job” — the schedule was sent with isEnabled: false. This removes the connector’s current schedule first.
- “Scheduled time must be in the future” — a once schedule in the past.
- “Scheduled time is missing or is not a valid date” — a once schedule without a readable top-level scheduledTime.
- “This schedule can’t be used: it never produces a run time. Check the cron expression and the timezone name, then try again.” — a cron expression or timezone the scheduler can’t use.
Every one of these except the disabled schedule is checked before anything is removed, so the connector’s existing schedule keeps running.
401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:write scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:write”.
403 Forbidden — the caller may not manage this connector: HTTP_FORBIDDEN “You are not authorized to schedule this connector” (a team connector needs an admin; a personal one, the person who created it).
404 Not Found — no connector instance with that connectorId is visible to the caller.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”
500 Internal Server Error — the queue answered, but part of the removal failed: HTTP_INTERNAL_SERVER_ERROR with one of these messages, which say what may still be in place:
- “This connector’s sync schedule could not be removed, so it may keep running. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”
- “A sync already queued for this connector could not be cancelled, so it may still run. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”
- “The previous one-time sync for this connector could not be cleared, so a new one can’t be scheduled yet. If it is still running, wait for it to finish; otherwise try again in a moment.”

GET /:connector/:connectorId/schedule - Get Job Status

Retrieve the status of a scheduled crawling job for a specific connector.Endpoint: GET /api/v1/crawlingManager/:connector/:connectorId/scheduleParameters:

connector (string, path) - The connector type
connectorId (string, path) - The connector instance ID

Success Response
Error Responses

Status: 200 OKA scheduled, repeating job that is running now:

{
  "success": true,
  "message": "Job status retrieved successfully",
  "data": {
    "id": "repeat:9b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e:1705392000000",
    "name": "crawl-box-66a0c1d2e3f4a5b6c7d8e9f0",
    "data": {
      "connector": "box",
      "connectorId": "66a0c1d2e3f4a5b6c7d8e9f0",
      "scheduleConfig": {
        "scheduleType": "daily",
        "hour": 9,
        "minute": 0,
        "isEnabled": true,
        "timezone": "UTC"
      },
      "orgId": "64f1a2b3c4d5e6f7a8b9c0d1",
      "userId": "64f1a2b3c4d5e6f7a8b9c0d2",
      "timestamp": "2024-01-15T09:00:00.000Z"
    },
    "progress": 20,
    "delay": 0,
    "timestamp": 1705392000000,
    "attemptsMade": 0,
    "processedOn": 1705392000500,
    "state": "active"
  }
}

id is the ID the job queue (BullMQ) gave this run; repeating runs look like repeat:<key>:<time in ms>. A one-time (once) job’s id is crawl-{connector}-{connectorId}-{orgId}, and so is a paused schedule’s.
name is crawl-{connector}-{connectorId}.
Fields with no value, such as finishedOn or failedReason on a job that hasn’t finished, are left out.

A paused schedule is reported from memory, with "state": "paused", "progress": 0, "attemptsMade": 0, and timestamp set to when it was paused.Job States:

waiting or prioritized - Queued, waiting for a worker
delayed - Due later (the next repeating run, or a one-time run’s scheduled time)
active - Being processed now
failed - The last run failed after its retries
paused - Paused through this API

Runs that completed successfully (completed) aren’t reported. Failed runs are, for as long as the queue keeps them (see Job history retention below), so a schedule that was removed, or a one-time sync that failed, can still be reported with "state": "failed". The endpoint answers 404 “No scheduled job found for this connector” only when the connector has no paused schedule and no waiting, prioritized, delayed, active or failed job.Progress Tracking: Jobs report progress at key stages: 10% (start), 20% (task service obtained), 100% (completion). Failed jobs may show partial progress.

Status: 404 Not Found — the connector has no scheduled job. This answer comes from the endpoint itself, so it has its own shape:

{
  "success": false,
  "message": "No scheduled job found for this connector",
  "data": null
}

Other errors use the standard error shape (see Error Handling):

401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:read scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:read”.
403 Forbidden — the caller may not manage this connector: HTTP_FORBIDDEN “You are not authorized to schedule this connector” (a team connector needs an admin; a personal one, the person who created it).
404 Not Found — no connector instance with that connectorId is visible to the caller.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”

GET /schedule/all - Get All Job Statuses

Retrieve all scheduled crawling jobs for the organization.Endpoint: GET /api/v1/crawlingManager/schedule/all

Success Response
Error Responses

Status: 200 OKThe list holds, for each connector type (the connector value, such as drive, across all of that type’s instances), up to its 10 most recent queued, delayed, active or failed jobs, followed by every paused schedule in the organization. Runs that completed successfully aren’t listed; failed ones are, including those of a schedule that has since been removed. Each entry has the same fields as Get Job Status; this example shortens scheduleConfig.

{
  "success": true,
  "message": "All job statuses retrieved successfully",
  "data": [
    {
      "id": "repeat:4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b:1705478400000",
      "name": "crawl-github-66a0c1d2e3f4a5b6c7d8e9f1",
      "data": {
        "connector": "github",
        "connectorId": "66a0c1d2e3f4a5b6c7d8e9f1",
        "scheduleConfig": { "scheduleType": "daily", "hour": 9, "minute": 0, "isEnabled": true, "timezone": "UTC" },
        "orgId": "64f1a2b3c4d5e6f7a8b9c0d1",
        "userId": "64f1a2b3c4d5e6f7a8b9c0d2",
        "timestamp": "2024-01-15T09:00:00.000Z"
      },
      "progress": 0,
      "delay": 86400000,
      "timestamp": 1705392000000,
      "attemptsMade": 0,
      "state": "delayed"
    },
    {
      "id": "repeat:0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d:1705397400000",
      "name": "crawl-linear-66a0c1d2e3f4a5b6c7d8e9f3",
      "data": {
        "connector": "linear",
        "connectorId": "66a0c1d2e3f4a5b6c7d8e9f3",
        "scheduleConfig": { "scheduleType": "hourly", "minute": 30, "interval": 2, "isEnabled": true, "timezone": "UTC" },
        "orgId": "64f1a2b3c4d5e6f7a8b9c0d1",
        "userId": "64f1a2b3c4d5e6f7a8b9c0d2",
        "timestamp": "2024-01-15T09:30:00.000Z"
      },
      "progress": 10,
      "delay": 0,
      "timestamp": 1705390200000,
      "attemptsMade": 0,
      "processedOn": 1705397400300,
      "state": "active"
    },
    {
      "id": "crawl-zendesk-66a0c1d2e3f4a5b6c7d8e9f2-64f1a2b3c4d5e6f7a8b9c0d1",
      "name": "crawl-zendesk-66a0c1d2e3f4a5b6c7d8e9f2",
      "data": {
        "connector": "zendesk",
        "connectorId": "66a0c1d2e3f4a5b6c7d8e9f2",
        "scheduleConfig": { "scheduleType": "weekly", "daysOfWeek": [1, 3, 5], "hour": 10, "minute": 0, "isEnabled": true, "timezone": "UTC" },
        "orgId": "64f1a2b3c4d5e6f7a8b9c0d1",
        "userId": "64f1a2b3c4d5e6f7a8b9c0d2",
        "timestamp": "2024-01-15T08:00:00.000Z"
      },
      "progress": 0,
      "timestamp": 1705305600000,
      "attemptsMade": 0,
      "state": "paused"
    }
  ]
}

Errors use the standard error shape (see Error Handling):

401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:read scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:read”.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”

DELETE /:connector/:connectorId/remove - Remove Job

Remove a scheduled crawling job for a specific connector.Endpoint: DELETE /api/v1/crawlingManager/:connector/:connectorId/removeParameters:

connector (string, path) - The connector type
connectorId (string, path) - The connector instance ID

Success Response
Error Responses

Status: 200 OK

{
  "success": true,
  "message": "Crawling job removed successfully"
}

Errors use the standard error shape (see Error Handling):

401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:delete scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:delete”.
403 Forbidden — the caller may not manage this connector: HTTP_FORBIDDEN “You are not authorized to schedule this connector” (a team connector needs an admin; a personal one, the person who created it).
404 Not Found — no connector instance with that connectorId is visible to the caller.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”
500 Internal Server Error — the queue answered, but part of the removal failed: HTTP_INTERNAL_SERVER_ERROR with one of these messages, which say what may still be in place:
- “This connector’s sync schedule could not be removed, so it may keep running. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”
- “A sync already queued for this connector could not be cancelled, so it may still run. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”

DELETE /schedule/all - Remove All Jobs

Remove all scheduled crawling jobs for the organization. Admins only: any other caller is refused with 400 “Admin access required”, and nothing is removed.Endpoint: DELETE /api/v1/crawlingManager/schedule/all

Success Response
Error Responses

Status: 200 OK

{
  "success": true,
  "message": "All crawling jobs removed successfully"
}

Errors use the standard error shape (see Error Handling):

400 Bad Request — the caller isn’t an admin: HTTP_BAD_REQUEST “Admin access required”. Nothing is removed.
401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:delete scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:delete”.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”
500 Internal Server Error — the queue answered, but part of the removal failed: HTTP_INTERNAL_SERVER_ERROR with one of these messages, which say what may still be in place:
- “Some sync schedules in this organization could not be removed, so they may keep running. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”

POST /:connector/:connectorId/pause - Pause Job

Pause a scheduled crawling job for a specific connector.Endpoint: POST /api/v1/crawlingManager/:connector/:connectorId/pauseParameters:

connector (string, path) - The connector type
connectorId (string, path) - The connector instance ID

Success Response
Error Responses

Status: 200 OK

{
  "success": true,
  "message": "Crawling job paused successfully",
  "data": {
    "connector": "airtable",
    "orgId": "64f1a2b3c4d5e6f7a8b9c0d1",
    "pausedAt": "2024-01-15T10:30:00.000Z"
  }
}

Errors use the standard error shape (see Error Handling):

400 Bad Request — HTTP_BAD_REQUEST “No active job found to pause” or “Job is already paused”.
401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:write scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:write”.
403 Forbidden — the caller may not manage this connector: HTTP_FORBIDDEN “You are not authorized to schedule this connector” (a team connector needs an admin; a personal one, the person who created it).
404 Not Found — no connector instance with that connectorId is visible to the caller.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”
500 Internal Server Error — the queue answered, but part of the removal failed: HTTP_INTERNAL_SERVER_ERROR with one of these messages, which say what may still be in place:
- “This connector’s sync schedule could not be removed, so it may keep running. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”
- “A sync already queued for this connector could not be cancelled, so it may still run. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”

POST /:connector/:connectorId/resume - Resume Job

Resume a paused crawling job for a specific connector.Endpoint: POST /api/v1/crawlingManager/:connector/:connectorId/resumeParameters:

connector (string, path) - The connector type
connectorId (string, path) - The connector instance ID

Success Response
Error Responses

Status: 200 OK

{
  "success": true,
  "message": "Crawling job resumed successfully",
  "data": {
    "connector": "dropbox", 
    "orgId": "64f1a2b3c4d5e6f7a8b9c0d1",
    "resumedAt": "2024-01-15T10:35:00.000Z"
  }
}

Errors use the standard error shape (see Error Handling):

400 Bad Request — HTTP_BAD_REQUEST “No paused job found to resume”.
400 Bad Request — HTTP_BAD_REQUEST “Scheduled time must be in the future”: a paused once schedule whose time has already passed. This is checked before anything changes, and the schedule stays paused.
401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:write scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:write”.
403 Forbidden — the caller may not manage this connector: HTTP_FORBIDDEN “You are not authorized to schedule this connector” (a team connector needs an admin; a personal one, the person who created it).
404 Not Found — no connector instance with that connectorId is visible to the caller.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”
500 Internal Server Error — resuming schedules the job again, and that replaces what’s in the queue. If part of that removal fails after the queue answered: HTTP_INTERNAL_SERVER_ERROR with one of these messages, which say what may still be in place:
- “This connector’s sync schedule could not be removed, so it may keep running. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”
- “A sync already queued for this connector could not be cancelled, so it may still run. Try again in a moment; if this keeps happening, ask your admin to check the job queue.”
- “The previous one-time sync for this connector could not be cleared, so a new one can’t be scheduled yet. If it is still running, wait for it to finish; otherwise try again in a moment.” (a once schedule)

GET /stats - Get Queue Statistics

Retrieve statistics about the crawling job queue.Endpoint: GET /api/v1/crawlingManager/stats

Success Response
Error Responses

Status: 200 OK

{
  "success": true,
  "message": "Queue statistics retrieved successfully",
  "data": {
    "waiting": 5,
    "active": 2,
    "completed": 120,
    "failed": 3,
    "delayed": 1,
    "paused": 2,
    "repeatable": 8,
    "total": 141
  }
}

Statistics Fields:

waiting - Number of jobs waiting to be processed
active - Number of jobs currently being processed
completed - Number of completed jobs
failed - Number of failed jobs
delayed - Number of delayed jobs
paused - Number of paused jobs
repeatable - Number of repeatable/scheduled jobs
total - Total number of jobs across all states

Errors use the standard error shape (see Error Handling):

401 Unauthorized — no valid sign-in token, for example HTTP_UNAUTHORIZED “No token provided” or “Session expired, please login again”.
403 Forbidden — an OAuth token without the crawl:read scope: HTTP_FORBIDDEN “Insufficient scope. Required: crawl:read”.
500 Internal Server Error — the job queue couldn’t be reached: INTERNAL_ERROR “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.”

Data Types

Enums
Interfaces

enum CrawlingScheduleType {
  HOURLY = 'hourly',
  DAILY = 'daily', 
  WEEKLY = 'weekly',
  MONTHLY = 'monthly',
  CUSTOM = 'custom',
  ONCE = 'once',
  INTERVAL = 'interval'
}

interface CrawlingJobData {
  connector: string;
  connectorId: string;
  scheduleConfig: ICrawlingSchedule;
  orgId: string;
  userId: string;
  timestamp: Date;
  metadata?: Record<string, any>;
}

interface ScheduleJobOptions {
  priority?: number;        // 1-10, default: 5
  maxRetries?: number;      // 0-10, default: 3  
  timeout?: number;         // 1000-600000ms, default: 300000 (5 minutes)
  metadata?: Record<string, any>;
}

interface JobStatus {
  id: string | undefined;
  name: string;
  data: CrawlingJobData;
  progress: JobProgress;   // Number (0-100) or object from BullMQ
  delay: number | undefined;
  timestamp: number;
  attemptsMade: number;
  finishedOn: number | undefined;
  processedOn: number | undefined; 
  failedReason: string | undefined;
  state: string;            // waiting, prioritized, delayed, active, failed, or paused
}

System Configuration

Rate Limiting
Job Lifecycle
Sync Events

The API includes built-in rate limiting and concurrency controls:

Maximum 5 concurrent jobs per queue
Jobs are automatically retried with exponential backoff (5000ms initial delay) on failure
Stalled jobs are detected after 30 seconds
Maximum 3 retry attempts for failed jobs
Job history retention: when a run finishes, the queue keeps at most the 10 most recent completed runs and the 10 most recent failed runs, counted across the whole queue rather than per connector. Removing or replacing a connector’s schedule also trims that connector instance’s finished runs to its 10 most recent. Completed runs are kept in the queue and counted by GET /stats, but Get Job Status and Get All leave them out; failed runs appear in all three
Jobs are removed and recreated when updating schedules (no job modification). The new schedule’s time, cron expression and timezone are checked first, so a schedule refused for those reasons never removes the one already in place. A schedule sent with isEnabled: false still clears the current one
Removing or pausing a schedule also cancels its runs that are waiting to start, including one-time runs. If the job queue can’t be reached, the request fails with 500 instead of reporting success, and a schedule is marked paused only after its runs are removed

When a scheduled run is due, the crawling manager publishes a sync event for that connector instance. The event type is the connector name, lowercased with spaces removed, followed by .resync (for example drive.resync or onedrive.resync). The payload carries orgId, connector, connectorId, origin: 'CONNECTOR', the user who scheduled it (syncedBy), and timestamps.A scheduled Local FS run is skipped, and counted as done, while no desktop app is connected.

Error Handling

Errors raised by these endpoints use the API’s standard error shape:

{
  "error": {
    "code": "HTTP_BAD_REQUEST",
    "message": "Scheduled time must be in the future",
    "requestId": "…"
  }
}

code is HTTP_ followed by the status name (HTTP_BAD_REQUEST, HTTP_UNAUTHORIZED, HTTP_FORBIDDEN, HTTP_NOT_FOUND), or VALIDATION_ERROR when the request doesn’t match the schema. A 500 comes in two kinds. When the job queue can’t be reached, the code is INTERNAL_ERROR with the message “Something went wrong on PipesHub’s side. Please try again; if it keeps happening, ask your admin for help.” When the queue answered but removing a schedule or a queued run failed, the code is HTTP_INTERNAL_SERVER_ERROR with a specific message that says what may still be in place; each endpoint’s tab lists them. requestId is included when the request has one. The only exception is the 404 for a connector with no scheduled job, shown under Get Job Status. Common HTTP Status Codes:

200 - Success
201 - Created (for scheduling jobs)
400 - Bad Request (validation errors, invalid configuration, or a non-admin calling Remove All)
401 - Unauthorized (missing or invalid authentication)
403 - Forbidden (not allowed to manage this connector, or an OAuth token missing the scope)
404 - Not Found (connector instance not found, or no scheduled job)
500 - Internal Server Error

Welcome To PipesHub

System Overview

Authentication

Mail Configuration

AI Providers

Connectors

Integrations

Agents

Toolsets

MCP Server

User Management

Deployment

Developer

Additional Resources

Crawling manager

Crawling Manager API

Base URL

Authentication

Path Parameters

API Endpoints

Data Types

System Configuration

Error Handling

​Crawling Manager API

​Base URL

​Authentication

​Path Parameters

​API Endpoints

​Data Types

​System Configuration

​Error Handling

Crawling Manager API

Base URL

Authentication

Path Parameters

API Endpoints

Data Types

System Configuration

Error Handling