Background jobs

Email, PDF, sync and recurring work the server does later.

Paths are relative to https://evenbooks.org/api/v1. How keys, errors, paging and versions work is in the guide; the whole reference is also an OpenAPI 3.1 document.

Administrator key marks endpoints that need a key with the admin role, Write access those a read-only key can’t call, and Idempotent those that accept an idempotency key.

Get background job status

get/jobs/status

Work the server does later for this company: queue counts, the 50 latest failed jobs (with their error message and whether they can be retried), events not yet dispatched, bank connections that stopped syncing, emails that failed or bounced, online payment events that failed, and when the worker last ran.

Response 200

JobStatusDto

queuesarray of object
Show 6 fields of each item
- namestring
- creatednumber
- activenumber
- retrynumber
- failednumber
- completednumber
failedJobsarray of object
Show 9 fields of each item
- idstring
- namestring
- createdOnstring
- completedOnstring or null
- retryCountnumber
- outputany
- dataany
- retryableboolean
- retryFailedJobRetryDto or null
outboxPendingnumber
outboxOldestAgeSecondsnumber or null
staleConnectionsarray of object
Show 4 fields of each item
- idstring
- namestring
- lastSuccessAtstring or null
- lastErrorstring or null
emailProblemsarray of object
Show 6 fields of each item
- idstring
- invoiceIdstring or null
- toEmailstring
- statusstring
- lastErrorstring or null
- queuedAtstring
workerHeartbeatAtstring or null
processorEventProblemsarray of ProcessorEventProblemDto

Errors 400 · 401 · 403 · 404 · 409 · 429

Schemas

The types these endpoints take or return, by name. Type names above link here.

FailedJobRetryDto

requestedAtstring
dispatchedAtstring or null

ProcessorEventProblemDto

idnumber
eventTypestring
receivedAtstring
attemptsnumber
lastErrorstring or null