Skip to main content
GET
Poll a Custom Link job
Requires custom_links:read or custom_links:write. Store the response ETag and send it as If-None-Match on the next poll. Unchanged jobs return 304 Not Modified. Begin at a two-second interval and back off to five seconds after 30 seconds.

Authorizations

Authorization
string
header
required

Hobbes API key with the hb_live_ prefix.

Headers

If-None-Match
string | null

Path Parameters

job_id
string<uuid>
required

Custom Link job UUID.

Response

Successful Response

id
string<uuid>
required
type
enum<string>
required
Available options:
create,
thumbnail,
retry
status
enum<string>
required
Available options:
queued,
processing,
completed,
completed_with_errors,
cancelled,
failed
totalItems
integer
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
campaignId
string<uuid> | null
parentJobId
string<uuid> | null
createdCount
integer
default:0
failedCount
integer
default:0
thumbnailQueuedCount
integer
default:0
thumbnailProcessingCount
integer
default:0
thumbnailGeneratedCount
integer
default:0
thumbnailProvidedCount
integer
default:0
thumbnailFallbackCount
integer
default:0
thumbnailFailedCount
integer
default:0
progress
number
default:0
Required range: 0 <= x <= 100
pollAfterSeconds
integer
default:2
Required range: 1 <= x <= 60
cancelRequested
boolean
default:false
startedAt
string<date-time> | null
completedAt
string<date-time> | null