Viewrium Docs
Objects

The Webhook delivery object

One event sent to an endpoint - its latest attempt, its status and its retries.

WebhookDeliveryResponse

JavaScript: no alias - an element of the type that holds it · Python: viewrium.WebhookDelivery

iduuidrequired

Unique identifier.

endpoint_iduuidrequired

The endpoint it was sent to.

event_typeWebhookEventTyperequired

The event's type.

One of "model.ready", "model.failed", "product.created", "product.generating", "product.completed", "product.failed", "product.reviewed", "product.published", "product.unpublished", "product.updated", "product.deleted", "export.ready"

event_iduuidrequired

The event's id. Stable across attempts - use it to deduplicate.

http_statusintegeroptionalnullable

The status your endpoint answered on the latest attempt. Null if it never answered.

attemptsintegerrequired

How many attempts were made (at most 6: immediately, then after 5 min, 30 min, 2 h, 8 h and 24 h).

succeeded_atdatetimeoptionalnullable

When your endpoint accepted it. Null until it does.

last_attempt_atdatetimeoptionalnullable

When the latest attempt was made.

last_errorstringoptionalnullable

What went wrong on the latest failed attempt.

next_attempt_atdatetimeoptionalnullable

When the next attempt is due. Null once it succeeded or its attempts ran out.

payload_jsonmap of string to anyoptionalnullable

The event body sent, identical on every attempt.

WebhookDeliveryListResponse

JavaScript: WebhookDeliveryList · Python: viewrium.WebhookDeliveryListResponse

The deliveries, newest first.

limitintegerrequired

The page size the list was read with.

offsetintegerrequired

How many items were skipped before this page.

On this page