🟢API for Webhooks

This page describe how to manage Webhooks via API>

Webhooks are automated notifications sent from one platform to another when a specific event occurs.

You can also read about webhooks here.

What can you do?

  • Create/update a webhook destination for a dataset


Create/update a webhook destination for a dataset

It’s highly recommended to set up a webhook as soon as possible. Webhooks provide a more convenient and robust way to receive results for each skin analysis, using a push model for instant updates. This method is more efficient and requires fewer resources for both the client and server.

• Webhooks are currently tied to datasets.

• Each dataset can have only one webhook destination (this may be updated in the future).

By configuring a webhook, you can automatically receive results without needing to constantly request updates.

Face Skin Metrics 2.0 webhook payload example
{
    "application_id": "0ab53382-a1df-4733-94da-308b3d2e6db1",
    "application_name": "Face Skin Metrics 2.0",
    "application_run_id": "a966897b-3999-44fd-b9e5-73eae50bf421",
    "area_results": [
        {
            "area_name": "face",
            "name": "Skin tone",
            "sub_metrics": [],
            "tech_name": "skintone_class",
            "value": "Light",
            "widget_meta": null,
            "widget_type": "category"
        },
        {
            "area_name": "face",
            "name": "Eye Age",
            "sub_metrics": [],
            "tech_name": "eye_age",
            "value": 38,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "left_eye_area",
            "name": "Left Eye Age",
            "sub_metrics": [],
            "tech_name": "left_eye_age",
            "value": 39,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "right_eye_area",
            "name": "Right Eye Age",
            "sub_metrics": [],
            "tech_name": "right_eye_age",
            "value": 37,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "face",
            "name": "Perceived Age",
            "sub_metrics": [],
            "tech_name": "perceived_age",
            "value": 36,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "face",
            "name": "Skin type",
            "sub_metrics": [
                {
                    "name": "U-zone skin type",
                    "tech_name": "u_zone_skin_type_class",
                    "value": "Oily",
                    "widget_meta": null,
                    "widget_type": "category"
                },
                {
                    "name": "T-zone skin type",
                    "tech_name": "t_zone_skin_type_class",
                    "value": "Oily",
                    "widget_meta": null,
                    "widget_type": "category"
                }
            ],
            "tech_name": "face_skin_type_class",
            "value": "Oily",
            "widget_meta": null,
            "widget_type": "category"
        },
        {
            "area_name": "face",
            "name": "Pores Score",
            "sub_metrics": [
                {
                    "name": "Pores Number",
                    "tech_name": "pores_number",
                    "value": 1246,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "Pores Density",
                    "tech_name": "pores_density",
                    "value": 2,
                    "widget_meta": null,
                    "widget_type": "density"
                }
            ],
            "tech_name": "Pores_score",
            "value": 33,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "nose",
            "name": "Pores Score",
            "sub_metrics": [],
            "tech_name": "Pores_score",
            "value": 62,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "forehead",
            "name": "Pores Score",
            "sub_metrics": [],
            "tech_name": "Pores_score",
            "value": 25,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "right_cheek",
            "name": "Pores Score",
            "sub_metrics": [],
            "tech_name": "Pores_score",
            "value": 16,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "left_cheek",
            "name": "Pores Score",
            "sub_metrics": [],
            "tech_name": "Pores_score",
            "value": 35,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "face",
            "name": "Image Quality Score",
            "sub_metrics": [
                {
                    "name": "full_face_score",
                    "tech_name": "full_face_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "rotation_score",
                    "tech_name": "rotation_score",
                    "value": 97,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "angles_yaw_angle_degree",
                    "tech_name": "angles_yaw_angle_degree",
                    "value": 2,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "angles_pitch_angle_degree",
                    "tech_name": "angles_pitch_angle_degree",
                    "value": -4,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "occlusion_score",
                    "tech_name": "occlusion_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "overlap_forehead_skin_mesh_areas_iou",
                    "tech_name": "overlap_forehead_skin_mesh_areas_iou",
                    "value": 95,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "overlap_right_cheek_skin_mesh_areas_iou",
                    "tech_name": "overlap_right_cheek_skin_mesh_areas_iou",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "overlap_left_cheek_skin_mesh_areas_iou",
                    "tech_name": "overlap_left_cheek_skin_mesh_areas_iou",
                    "value": 98,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "overlap_right_eye_inner_skin_mesh_areas_iou",
                    "tech_name": "overlap_right_eye_inner_skin_mesh_areas_iou",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "overlap_left_eye_inner_skin_mesh_areas_iou",
                    "tech_name": "overlap_left_eye_inner_skin_mesh_areas_iou",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "resolution_score",
                    "tech_name": "resolution_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "eye_width_px",
                    "tech_name": "eye_width_px",
                    "value": 294,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "eye_height_px",
                    "tech_name": "eye_height_px",
                    "value": 99,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "right_eye_openness",
                    "tech_name": "right_eye_openness",
                    "value": 0,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "left_eye_openness",
                    "tech_name": "left_eye_openness",
                    "value": 0,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "nose_height_px",
                    "tech_name": "nose_height_px",
                    "value": 265,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "focus_score",
                    "tech_name": "focus_score",
                    "value": 78,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "raw_sharpness",
                    "tech_name": "raw_sharpness",
                    "value": 513,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "lightness_score",
                    "tech_name": "lightness_score",
                    "value": 92,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "light_direction_score",
                    "tech_name": "light_direction_score",
                    "value": 99,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "light_source_azimuth",
                    "tech_name": "light_source_azimuth",
                    "value": 0,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "intensity",
                    "tech_name": "intensity",
                    "value": 97,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "colortone_score",
                    "tech_name": "colortone_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "right_eye_inner_whites_a_channel",
                    "tech_name": "right_eye_inner_whites_a_channel",
                    "value": -1,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "right_eye_inner_whites_b_channel",
                    "tech_name": "right_eye_inner_whites_b_channel",
                    "value": 0,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "left_eye_inner_whites_a_channel",
                    "tech_name": "left_eye_inner_whites_a_channel",
                    "value": 0,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "left_eye_inner_whites_b_channel",
                    "tech_name": "left_eye_inner_whites_b_channel",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "shadows_score",
                    "tech_name": "shadows_score",
                    "value": 99,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "shadows",
                    "tech_name": "shadows",
                    "value": 7,
                    "widget_meta": null,
                    "widget_type": "numeric"
                }
            ],
            "tech_name": "image_quality_score",
            "value": 92,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "face",
            "name": "Eye Area Condition",
            "sub_metrics": [
                {
                    "name": "Dark Circle Score",
                    "tech_name": "dark_circles_score",
                    "value": 68,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Eye Bags Score",
                    "tech_name": "eye_bags_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Lacrimal Grooves Score",
                    "tech_name": "lacrimal_grooves_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Dark Circle Grade",
                    "tech_name": "dark_circles_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Eye Bags Grade",
                    "tech_name": "eye_bags_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Lacrimal Grooves Grade",
                    "tech_name": "lacrimal_grooves_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Severity",
                    "tech_name": "severity",
                    "value": "present",
                    "widget_meta": null,
                    "widget_type": "category"
                }
            ],
            "tech_name": "eye_area_condition",
            "value": 0,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "left_eye_area",
            "name": "Eye Area Condition",
            "sub_metrics": [
                {
                    "name": "Dark Circle Score",
                    "tech_name": "dark_circles_score",
                    "value": 64,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Eye Bags Score",
                    "tech_name": "eye_bags_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Lacrimal Grooves Score",
                    "tech_name": "lacrimal_grooves_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Dark Circle Grade",
                    "tech_name": "dark_circles_grade",
                    "value": 2,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Eye Bags Grade",
                    "tech_name": "eye_bags_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Lacrimal Grooves Grade",
                    "tech_name": "lacrimal_grooves_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "eye_area_condition",
            "value": 0,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "right_eye_area",
            "name": "Eye Area Condition",
            "sub_metrics": [
                {
                    "name": "Dark Circle Score",
                    "tech_name": "dark_circles_score",
                    "value": 72,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Eye Bags Score",
                    "tech_name": "eye_bags_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Lacrimal Grooves Score",
                    "tech_name": "lacrimal_grooves_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Dark Circle Grade",
                    "tech_name": "dark_circles_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Eye Bags Grade",
                    "tech_name": "eye_bags_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Lacrimal Grooves Grade",
                    "tech_name": "lacrimal_grooves_grade",
                    "value": 1,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "eye_area_condition",
            "value": 0,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "face",
            "name": "Redness Score",
            "sub_metrics": [
                {
                    "name": "Redness Local Score",
                    "tech_name": "redness_local_score",
                    "value": 94,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Redness Global Score",
                    "tech_name": "redness_global_score",
                    "value": 74,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "redness_score",
            "value": 75,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "nose",
            "name": "Redness Score",
            "sub_metrics": [
                {
                    "name": "Redness Local Score",
                    "tech_name": "redness_local_score",
                    "value": 71,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Redness Global Score",
                    "tech_name": "redness_global_score",
                    "value": 71,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "redness_score",
            "value": 71,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "forehead",
            "name": "Redness Score",
            "sub_metrics": [
                {
                    "name": "Redness Local Score",
                    "tech_name": "redness_local_score",
                    "value": 100,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Redness Global Score",
                    "tech_name": "redness_global_score",
                    "value": 74,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "redness_score",
            "value": 77,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "right_cheek",
            "name": "Redness Score",
            "sub_metrics": [
                {
                    "name": "Redness Local Score",
                    "tech_name": "redness_local_score",
                    "value": 96,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Redness Global Score",
                    "tech_name": "redness_global_score",
                    "value": 74,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "redness_score",
            "value": 76,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "left_cheek",
            "name": "Redness Score",
            "sub_metrics": [
                {
                    "name": "Redness Local Score",
                    "tech_name": "redness_local_score",
                    "value": 99,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Redness Global Score",
                    "tech_name": "redness_global_score",
                    "value": 74,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "redness_score",
            "value": 76,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "chin",
            "name": "Redness Score",
            "sub_metrics": [
                {
                    "name": "Redness Local Score",
                    "tech_name": "redness_local_score",
                    "value": 94,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Redness Global Score",
                    "tech_name": "redness_global_score",
                    "value": 74,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                }
            ],
            "tech_name": "redness_score",
            "value": 76,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "face",
            "name": "Uniformness Score",
            "sub_metrics": [],
            "tech_name": "uniformness_score",
            "value": 36,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "forehead_n_bridge",
            "name": "Uniformness Score",
            "sub_metrics": [],
            "tech_name": "uniformness_score",
            "value": 40,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "right_cheek",
            "name": "Uniformness Score",
            "sub_metrics": [],
            "tech_name": "uniformness_score",
            "value": 40,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "left_cheek",
            "name": "Uniformness Score",
            "sub_metrics": [],
            "tech_name": "uniformness_score",
            "value": 29,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "face",
            "name": "Pigmentation Score",
            "sub_metrics": [
                {
                    "name": "Severity",
                    "tech_name": "severity",
                    "value": "moderate",
                    "widget_meta": null,
                    "widget_type": "category"
                }
            ],
            "tech_name": "pigmentation_score",
            "value": 69,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "left_cheek",
            "name": "Pigmentation Score",
            "sub_metrics": [],
            "tech_name": "pigmentation_score",
            "value": 69,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "forehead",
            "name": "Pigmentation Score",
            "sub_metrics": [],
            "tech_name": "pigmentation_score",
            "value": 69,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "nose",
            "name": "Pigmentation Score",
            "sub_metrics": [],
            "tech_name": "pigmentation_score",
            "value": 69,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "right_cheek",
            "name": "Pigmentation Score",
            "sub_metrics": [],
            "tech_name": "pigmentation_score",
            "value": 69,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "chin",
            "name": "Pigmentation Score",
            "sub_metrics": [],
            "tech_name": "pigmentation_score",
            "value": 64,
            "widget_meta": null,
            "widget_type": "numeric"
        },
        {
            "area_name": "face",
            "name": "Age spots score",
            "sub_metrics": [
                {
                    "name": "Age spots grade",
                    "tech_name": "age_spots_grade",
                    "value": 5,
                    "widget_meta": null,
                    "widget_type": "numeric"
                },
                {
                    "name": "Age spots density",
                    "tech_name": "age_spots_density",
                    "value": 9,
                    "widget_meta": null,
                    "widget_type": "density"
                }
            ],
            "tech_name": "age_spots_score",
            "value": 68,
            "widget_meta": null,
            "widget_type": "bad_good_line"
        },
        {
            "area_name": "left_cheek",
            "name": "Age spots density",
            "sub_metrics": [],
            "tech_name": "age_spots_density",
            "value": 32,
            "widget_meta": null,
            "widget_type": "density"
        },
        {
            "area_name": "right_cheek",
            "name": "Age spots density",
            "sub_metrics": [],
            "tech_name": "age_spots_density",
            "value": 12,
            "widget_meta": null,
            "widget_type": "density"
        },
        {
            "area_name": "forehead",
            "name": "Age spots density",
            "sub_metrics": [],
            "tech_name": "age_spots_density",
            "value": 6,
            "widget_meta": null,
            "widget_type": "density"
        },
        {
            "area_name": "face",
            "name": "Lines Score",
            "sub_metrics": [
                {
                    "name": "Sagging Score",
                    "tech_name": "sagging_score",
                    "value": 57,
                    "widget_meta": null,
                    "widget_type": "bad_good_line"
                },
                {
                    "name": "Jowls Grade",
                    "tech_name": "jowls_grade",
                    "value": 1,
                    "widget_meta": null,