Skip to content
ShareOutShareOut Docs

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 } }'

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
artifact_id
required
string
title
string
<= 200 characters
description
string
<= 1000 characters
action
required
string
Allowed values: email webhook slack discord http_get materialize telegram query_snapshot sheets_append
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 email.received
config
required

Action-specific configuration.

object
retry_config
object
maxAttempts
integer
<= 10
backoffType
string
Allowed values: fixed linear exponential
initialDelay
integer
>= 60 <= 3600
Examples
ExampleweeklyEmail

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

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
job
object
id
string
artifact_id
string
title
string
<= 200 characters
description
string
<= 1000 characters
action
string
Allowed values: email webhook slack discord http_get materialize telegram query_snapshot sheets_append
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 email.received
config
object
enabled
boolean
next_run_at

ISO 8601; null for event-triggered jobs.

string format: date-time
nullable
last_run_at
string format: date-time
nullable
last_status
string
created_at
string format: date-time
updated_at
string format: date-time
nullable
Example
{
  "job": {
    "action": "email",
    "trigger_type": "cron",
    "event_type": "artifact.updated"
  }
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

403

Section titled “403”

No access to the artifact, or a viewer scheduling delivery to someone other than themselves (viewers may only send to their own email, their own Telegram, or a Slack DM to themselves).

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}