Skip to content
Artbucket

An automation's run log

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

Its latest 50 runs, newest first: what set each off, and every attempt at delivering it, with the webhook’s status or the error.

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”

200

Section titled “200”

Runs

Media typeapplication/json
object
data
required
Array<object>
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"
  }
}