Skip to content
Artbucket

Send a test

POST
/api/v1/automations/{id}/test
curl --request POST \
  --url http://localhost:3000/api/v1/automations/example/test \
  --header 'Authorization: Bearer <token>'

Send it now, on or off, with a sample event: for brand.released its brand’s latest release (the default brand’s for any brand), for asset.expiring the approved asset whose license ends soonest, else the newest; for governance the latest audit entry it takes, else one made up; for check.refused that asset; for fix.opened the first open Fix of its kind, else a made-up search; for review.waiting the oldest proposal, else the oldest asset. What it sends says test: true. One attempt, never tried again, kept in the run log marked as a test. A 422 when there is nothing to make a sample from.

Scope: write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Automation id

Responses

Section titled “Responses”

201

Section titled “201”

The run, delivered or failed

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required

Pending: delivering, or failed and tried again at nextAt; failed: after 3 attempts

string
Allowed values: pending delivered failed
payload
required

What the webhook posts, and what the email says

object
key
additional properties
attempts
required
Array<object>
object
at
required
string
ok
required
boolean
code
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
error
required
string | null
nextAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
test
required

Sent by Send a test (POST /api/v1/automations/{id}/test), with a sample event: its payload says test: true too

boolean
Example
{
  "data": {
    "status": "pending"
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}