Estimate 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.
estimate.generated
Recipient: ownerAn estimate finishes with a price. 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. |
estimate_id | Diamra's id for the estimate, the same id the API gives it. A new price for the same estimate sends this event again with the same id. |
price | The price with your markup, as a plain number such as 2450. currency names its currency. |
currency | The price's three-letter currency code, such as USD. |
confidence | How sure the estimate is, as a whole number from 0 to 100. The lower it is, the more the price can still change. It is null when the price is final. |
image_url | A link to the design being priced. |
piece_type | What the piece is, such as ring, earrings or pendant. |
style | Its style, such as halo_ring or stud_earrings. |
setting | How the stones are set, such as prong or bezel. The center stone's setting when there is one. |
metal | The metal the price is for, named as on the estimate, such as 14K Gold or Platinum. |
metal_color | The gold's color, such as yellow, white or rose. null for other metals. |
metal_options | The other metals listed under the price, each as { metal, price } in the same currency. |
center_stone | The main stone, with type (such as diamond), shape, carat_weight for one stone, count (2 for a pair of studs) and origin. origin is lab_grown or natural, as priced. For a stone the customer brings, origin is lab_grown when the stone was described as lab-grown, and null otherwise. origin is also null for other gems, such as a sapphire. center_stone itself is null when there is no center stone. |
total_carat_weight | The carats of every stone, added up. |
ring_size | The US ring size, on rings only. |
from | Where each detail above came from, one word per detail, under the same names. The words are listed on the "Messages from the studio" page, under "Where each detail came from". |
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. |
estimate.accepted
Recipient: ownerThe customer accepts a price. 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. |
estimate_id | The estimate the customer accepted, by the id the API gives it. |
price | The amount the customer said yes to, with your markup, as a plain number. currency names its currency. |
currency | The price's three-letter currency code, such as USD. |
piece_type | What the piece is, such as ring, earrings or pendant. |
style | Its style, such as halo_ring or stud_earrings. |
setting | How the stones are set, such as prong or bezel. The center stone's setting when there is one. |
metal | The metal the customer said yes to, named as on the estimate. |
metal_color | The gold's color, such as yellow, white or rose. null for other metals. |
metal_options | The other metals listed under the price, each as { metal, price } in the same currency. |
center_stone | The main stone, with type (such as diamond), shape, carat_weight for one stone, count (2 for a pair of studs) and origin. origin is lab_grown or natural, as priced. For a stone the customer brings, origin is lab_grown when the stone was described as lab-grown, and null otherwise. origin is also null for other gems, such as a sapphire. center_stone itself is null when there is no center stone. |
total_carat_weight | The carats of every stone, added up. |
ring_size | The US ring size, on rings only. |
from | Where each detail above came from, one word per detail, under the same names. The words are listed on the "Messages from the studio" page, under "Where each detail came from". |
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. |
image_url | A link to the accepted design. |
salon_url | Opens the project for the customer: on your store, or on your website when the project started in an embed. |