v29

OpenAPI 3.0.1raw.githubusercontent.com2026-06-030080.0 KB

Basic

Retrieve status

Retrieve the status of a specific webhook journal entry using its unique status ID. This endpoint provides detailed information about the status, including whether it is pending, in progress, completed, failed, or expired. It is useful for monitoring and managing the state of webhook journal entries.

get/webhooks-journal/journal/2026-03/status/{statusId}

Path parameters

statusIdstring uuid required

The unique identifier (UUID) of the status to retrieve.

Response

successful operation

completedAtinteger

The timestamp when the snapshot was completed, represented as an integer in int64 format. This field may be null if the snapshot is not yet completed.

errorCode'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'

An optional code indicating the error that occurred, if any. Possible values are 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'.

idstring uuid required

A unique identifier for the snapshot, represented as a UUID.

initiatedAtinteger required

The timestamp when the snapshot was initiated, represented as an integer in int64 format.

messagestring

A descriptive message providing additional information about the snapshot status or error.

status'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING' required

The current status of the snapshot. Valid values include 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'FAILED', and 'EXPIRED'.