Create a job

POST

/v1/jobs

curl --request POST \
  --url https://shareout.site/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "artifact_id": "art_abc123", "action": "email", "trigger_type": "cron", "schedule": "0 9 * * 1", "config": { "recipients": [ "team@company.com" ], "subject": "Weekly report", "includeArtifactLink": true } }'

• Production

Schedule a recurring (cron) or event-driven task.

Authorizations

• bearerAuth

Request Body ^required

Media type application/json

object

artifact_id

required

string

action

required

string

Allowed values: email webhook slack discord http_get materialize

trigger_type

string

default: cron

Allowed values: cron event

schedule

Required for cron jobs.

string

event_type

Required for event jobs.

string

Allowed values: artifact.updated artifact.viewed comment.added

config

required

Action-specific configuration.

object

retry_config

object

maxAttempts

integer

<= 10

backoffType

string

Allowed values: fixed linear exponential

initialDelay

integer

>= 60 <= 3600

Examples

Example weeklyEmail

Weekly email

{
  "artifact_id": "art_abc123",
  "action": "email",
  "trigger_type": "cron",
  "schedule": "0 9 * * 1",
  "config": {
    "recipients": [
      "team@company.com"
    ],
    "subject": "Weekly report",
    "includeArtifactLink": true
  }
}

Responses

200

Created

Media type application/json

object

id

string

artifact_id

string

action

string

Allowed values: email webhook slack discord http_get materialize

trigger_type

string

Allowed values: cron event

schedule

Cron expression (cron jobs only).

string

event_type

string

Allowed values: artifact.updated artifact.viewed comment.added

config

object

enabled

boolean

next_run_at

integer

last_run_at

integer

last_status

string

created_at

integer

Example

{
  "action": "email",
  "trigger_type": "cron",
  "event_type": "artifact.updated"
}

400

Invalid request

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}