Skip to main content
POST
/
{workspaceId}
/
projects
/
{projectName}
/
jobs
Create Job
curl --request POST \
  --url https://app.intuned.io/api/v1/workspace/{workspaceId}/projects/{projectName}/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "id": "my-awesome-job",
  "configuration": {
    "retry": {
      "maximumAttempts": 3
    }
  },
  "payload": [
    {
      "apiName": "my-awesome-api",
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      }
    }
  ]
}'
{
  "id": "<string>",
  "message": "created"
}

Authorizations

​
x-api-key
string
header
required

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string<uuid>
required

Your workspace ID. How to find it?

​
projectName
string
required

Your project name. It is the name you provide when creating a project.

Body

application/json

Job creation input schema

​
id
string
required

The ID of the job. Has to be a valid URL slug.

Minimum length: 7
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
payload
object[]
required

Array of API calls to be executed

​
configuration
object
required

Job configuration settings

​
schedule
object | null

Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time.

​
sink
object | null

Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. Configuration for the webhook sink.

  • Webhook Sink Configuration
  • S3 Sink Configuration
​
proxy
string | null

Proxy configuration for the job

Example:

"http://username:password@proxy.example.com:8080"

​
auth_session
object | null

Response

Job created successfully.

​
id
string
required

The ID of the created job.

​
message
enum<string>
required
Available options:
created
⌘I