v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB

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 indicating when the snapshot operation was completed, represented as a Unix timestamp in milliseconds.

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

A code representing the error that occurred, if any. Possible values are 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'.

idstring uuid required

The unique identifier for the snapshot operation, represented as a UUID.

initiatedAtinteger required

The timestamp indicating when the snapshot operation was initiated, represented as a Unix timestamp in milliseconds.

messagestring

A descriptive message providing additional information about the snapshot operation 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'.