Project events

Each event below says when it fires and lists the fields in its data. Event types explains who each event notifies, the fields that events share and the envelope around data.

To send a project's full report yourself when project.report_requested arrives, follow Send the full report from your own email.

project.started

owner

A customer starts a project, or your team starts one on your bench. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
design_id	Diamra's id for the set the design came from, as in design.generated.
image_url	A link to the design.
started_by	customer when the customer started it, owner when your team started it on your bench.
embed_origin	The page that framed the studio when the project started, as the browser reported it. Some browsers send only the site's address. null outside an embed.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
bench_url	Opens the project on your bench. It needs a bench sign-in.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.

project.measurements_ready

customer

Measurements are shared with the customer. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.

project.model_ready

customer

A 3D model is shared with the customer. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.

project.video_ready

customer

A video of the piece is shared with the customer. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.

project.crafting_photo_added

customer

A new photo of the piece in progress is shared. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.
image_url	A link to the new photo of the piece.

project.delivery_updated

customer

Delivery details are saved. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.

project.completed

customer

The project is marked complete. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. bench_url and salon_url use design_image_id instead.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.

project.report_requested

customer

A customer or your team asks for a project's full report by email. It carries a link to the report as a PDF, and the same report as data. A new endpoint starts with it picked.

Field	What it holds
project_id	Diamra's id for the project, the same as on the studio's messages. It is null for an older kept design that has no project id yet. design_image_id is always there.
design_image_id	The id of the design the project is for. It is the id in bench_url and salon_url.
requested_by	customer when the customer asked from your store, owner when your team asked from your bench.
delivery_email	The address the report should go to, as typed. It is not always the customer's own address.
report_url	A link to the report as a PDF, the one Diamra emails. It downloads the file and needs no sign-in. Anyone with the link can open it, so send it only to delivery_email.
image_url	A link to the design, the sharper picture when there is one. It is null when your store hides the design from customers.
views	The views of the piece that the customer sees, front first. Each has id, view (front, top, left or bottom), url and measurements. A measurement has id, type, label, mm, text, from and to, as the API's measurements do. The list is empty when there are none.
estimate	The price the customer sees, or null when there is none. It has the fields of estimate.accepted (estimate_id, price, currency and the piece), and accepted_at: when the customer accepted the price, as an ISO 8601 time in UTC, or null.
model_url	A link to the 3D model that the customer sees, a 3D file such as GLB, or null.
video_url	A link to the video that the customer sees, or null.
customer	The customer: id (Diamra's id for them), email, phone, first_name and name. Anything Diamra doesn't know is null.
salon_url	Opens the project for the customer: on your store, or on your website when the project started in an embed.
bench_url	Opens the project on your bench. It needs a bench sign-in.