Basic

Retrieve status

Changed on

Retrieve the status of a specific webhook journal snapshot entry using its snapshot ID. This endpoint is useful for checking the current state of a webhooks journal snapshot, such as whether it is pending, in progress, successful, failed, or expired.

get/webhooks-journal/journal/2027-03-beta/status/{statusId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/webhooks-journal/journal/2027-03-beta/status/{statusId}
  • Auth
    none required

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'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'SUCCESS' required

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

Changes

  • 2027-03-beta6995629a4549Revision changes
    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2027-03-beta0d8139833c65Revision changes
    • info

      api operation id get-/webhooks-journal/journal/2027-03-beta/status/{statusId} removed and replaced with get-/webhooks-journal/journal/2027-03-beta/status/{statusId}_/webhooks-journal/journal/2027-03-beta/status/{statusId}