The Webhook endpoint object
Every field of a webhook endpoint, and the signing secret a create answers.
See Webhooks for the events and how to verify a delivery's signature.
WebhookEndpointResponse
JavaScript: WebhookEndpoint · Python: viewrium.WebhookEndpoint
iduuidrequiredUnique identifier.
org_iduuidoptionalnullableThe organization the endpoint belongs to.
urlstringrequiredWhere events are POSTed (https).
descriptionstringoptionalnullableYour note about the endpoint.
eventsWebhookEventType[]requiredThe event types sent to this endpoint.
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"
enabledbooleanrequiredWhether events are being sent. A disabled endpoint receives nothing.
created_atdatetimerequiredWhen it was created.
updated_atdatetimerequiredWhen it was last changed.
WebhookEndpointCreateResponse
JavaScript: WebhookEndpointCreated · Python: viewrium.WebhookEndpointCreateResponse
A newly created webhook endpoint, with the signing_secret that signs its deliveries. The secret stays readable on the endpoint later.
iduuidrequiredUnique identifier.
org_iduuidoptionalnullableThe organization the endpoint belongs to.
urlstringrequiredWhere events are POSTed (https).
descriptionstringoptionalnullableYour note about the endpoint.
eventsWebhookEventType[]requiredThe event types sent to this endpoint.
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"
enabledbooleanrequiredWhether events are being sent. A disabled endpoint receives nothing.
created_atdatetimerequiredWhen it was created.
updated_atdatetimerequiredWhen it was last changed.
signing_secretstringrequiredThe secret that signs every delivery. Verify the signature with it. Also readable later.
WebhookEndpointListResponse
JavaScript: WebhookEndpointList · Python: viewrium.WebhookEndpointListResponse
The organization's endpoints.