--- title: "Update webhook properties" method: PATCH path: "/hooks/{id}/" tags: ["hooks"] --- # Update webhook properties `PATCH /hooks/{id}/` Use this method to update a webhook properties. ## Path parameters - `id` integer, required ## Request body - PatchedWebhookRequest — `WebHook` is an HTTP URL that is used to notify external services on newly created events - `name` string — Human-readable name for this webhook - `active` boolean — Inactive webhooks will not send any requests - `url` string, uri — Receiving URL - `batch_size` integer — Webhook messages batch size - `filters` WebhookFiltersRequest - `face_events` FaceEventsFiltersRequest - `matched_lists` integer[] - `camera_groups` integer[] - `cameras` integer[] - `matched_card_in` integer[] - `matched` boolean - `confidence_gte` number, float - `bs_type` string[] - `line` integer[] - `line_crossing_direction` LineCrossingDirectionEnum[] - `backward_line_crossing` boolean - `headpose_yaw_angle_gte` integer - `headpose_yaw_angle_lte` integer - `headpose_pitch_angle_gte` integer - `headpose_pitch_angle_lte` integer - `gender` string[] - `age_lte` integer - `age_gte` integer - `glasses` string[] - `emotions` string[] - `beard` string[] - `medmask` string[] - `liveness` string[] - `temperature_gte` number, float - `liveness_gte` number, float - `eyes_attrs` string[] - `eyes_attrs_score_gte` number, float - `eyes_attrs_score_lte` number, float - `body_events` BodyEventsFiltersRequest - `matched_lists` integer[] - `camera_groups` integer[] - `cameras` integer[] - `matched_card_in` integer[] - `matched` boolean - `confidence_gte` number, float - `bs_type` string[] - `line` integer[] - `line_crossing_direction` LineCrossingDirectionEnum[] - `backward_line_crossing` boolean - `headwear` string[] - `upper_clothes` string[] - `detailed_upper_clothes` string[] - `top_color` string[] - `lower_clothes` string[] - `bottom_color` string[] - `bag_hand_score_gte` number, float - `bag_hand_score_lte` number, float - `bag_hand` string[] - `bag_ground_score_gte` number, float - `bag_ground_score_lte` number, float - `bag_ground` string[] - `bag_back_score_gte` number, float - `bag_back_score_lte` number, float - `bag_back` string[] - `vest_type_score_gte` number, float - `vest_type_score_lte` number, float - `vest_type` string[] - `helmet_type_score_lte` number, float - `helmet_type_score_gte` number, float - `helmet_type` string[] - `age_group_score_lte` number, float - `age_group_score_gte` number, float - `age_group` string[] - `gender_score_lte` number, float - `gender_score_gte` number, float - `body_gender` string[] - `fall` string[] - `fall_score_lte` number, float - `fall_score_gte` number, float - `handface_smoking` string[] - `handface_smoking_score_lte` number, float - `handface_smoking_score_gte` number, float - `handface_phone_use` string[] - `handface_phone_use_score_lte` number, float - `handface_phone_use_score_gte` number, float - `handface_phone_call` string[] - `handface_phone_call_score_lte` number, float - `handface_phone_call_score_gte` number, float - `handface_taking_pictures` string[] - `handface_taking_pictures_score_lte` number, float - `handface_taking_pictures_score_gte` number, float - `car_events` CarEventsFiltersRequest - `matched_lists` integer[] - `camera_groups` integer[] - `cameras` integer[] - `matched_card_in` integer[] - `matched` boolean - `confidence_gte` number, float - `bs_type` string[] - `line` integer[] - `line_crossing_direction` LineCrossingDirectionEnum[] - `backward_line_crossing` boolean - `category_confidence_gte` number, float - `category_confidence_lte` number, float - `category_type` string[] - `color` string[] - `body` string[] - `make` string[] - `model` string[] - `license_plate_number` string[] - `license_plate_number_color` string[] - `license_plate_number_color_confidence_lte` number, float - `license_plate_number_color_confidence_gte` number, float - `license_plate_country` string[] - `license_plate_region` string[] - `special_vehicle_type` string[] - `weight_type` string[] - `weight_type_confidence_lte` number, float - `weight_type_confidence_gte` number, float - `orientation` string[] - `orientation_confidence_lte` number, float - `orientation_confidence_gte` number, float - `human_episodes` HumanEpisodesFiltersRequest - `allowed_types` string[] - `matched_lists` integer[] - `cameras` integer[] - `camera_groups` integer[] - `matched_card_in` integer[] - `events_count_gte` integer - `events_count_lte` integer - `face_matched` boolean - `body_matched` boolean - `car_episodes` CarEpisodesFiltersRequest - `allowed_types` string[] - `matched_lists` integer[] - `cameras` integer[] - `camera_groups` integer[] - `matched_card_in` integer[] - `events_count_gte` integer - `events_count_lte` integer - `car_matched` boolean - `counters` CounterFiltersRequest - `counter` integer[] - `cameras` integer[] - `camera_groups` integer[] - `faces_count_gte` integer - `faces_count_lte` integer - `silhouettes_count_gte` integer - `silhouettes_count_lte` integer - `cars_count_gte` integer - `cars_count_lte` integer - `proximity_min_lte` number, float - `proximity_min_gte` number, float - `proximity_avg_lte` number, float - `proximity_avg_gte` number, float - `proximity_max_lte` number, float - `proximity_max_gte` number, float - `areas` AreasFiltersRequest - `area_in` integer[] - `camera_in` integer[] - `camera_group_in` integer[] - `send_attempts` integer — Maximum number of attempts to send a webhook ## Response `200` - Webhook — `WebHook` is an HTTP URL that is used to notify external services on newly created events - `id` integer, required - `name` string, required — Human-readable name for this webhook - `active` boolean, required — Inactive webhooks will not send any requests - `url` string, uri, required — Receiving URL - `batch_size` integer — Webhook messages batch size - `filters` WebhookFilters, required - `face_events` FaceEventsFilters - `matched_lists` integer[] - `camera_groups` integer[] - `cameras` integer[] - `matched_card_in` integer[] - `matched` boolean - `confidence_gte` number, float - `bs_type` string[] - `line` integer[] - `line_crossing_direction` LineCrossingDirectionEnum[] - `backward_line_crossing` boolean - `headpose_yaw_angle_gte` integer - `headpose_yaw_angle_lte` integer - `headpose_pitch_angle_gte` integer - `headpose_pitch_angle_lte` integer - `gender` string[] - `age_lte` integer - `age_gte` integer - `glasses` string[] - `emotions` string[] - `beard` string[] - `medmask` string[] - `liveness` string[] - `temperature_gte` number, float - `liveness_gte` number, float - `eyes_attrs` string[] - `eyes_attrs_score_gte` number, float - `eyes_attrs_score_lte` number, float - `body_events` BodyEventsFilters - `matched_lists` integer[] - `camera_groups` integer[] - `cameras` integer[] - `matched_card_in` integer[] - `matched` boolean - `confidence_gte` number, float - `bs_type` string[] - `line` integer[] - `line_crossing_direction` LineCrossingDirectionEnum[] - `backward_line_crossing` boolean - `headwear` string[] - `upper_clothes` string[] - `detailed_upper_clothes` string[] - `top_color` string[] - `lower_clothes` string[] - `bottom_color` string[] - `bag_hand_score_gte` number, float - `bag_hand_score_lte` number, float - `bag_hand` string[] - `bag_ground_score_gte` number, float - `bag_ground_score_lte` number, float - `bag_ground` string[] - `bag_back_score_gte` number, float - `bag_back_score_lte` number, float - `bag_back` string[] - `vest_type_score_gte` number, float - `vest_type_score_lte` number, float - `vest_type` string[] - `helmet_type_score_lte` number, float - `helmet_type_score_gte` number, float - `helmet_type` string[] - `age_group_score_lte` number, float - `age_group_score_gte` number, float - `age_group` string[] - `gender_score_lte` number, float - `gender_score_gte` number, float - `body_gender` string[] - `fall` string[] - `fall_score_lte` number, float - `fall_score_gte` number, float - `handface_smoking` string[] - `handface_smoking_score_lte` number, float - `handface_smoking_score_gte` number, float - `handface_phone_use` string[] - `handface_phone_use_score_lte` number, float - `handface_phone_use_score_gte` number, float - `handface_phone_call` string[] - `handface_phone_call_score_lte` number, float - `handface_phone_call_score_gte` number, float - `handface_taking_pictures` string[] - `handface_taking_pictures_score_lte` number, float - `handface_taking_pictures_score_gte` number, float - `car_events` CarEventsFilters - `matched_lists` integer[] - `camera_groups` integer[] - `cameras` integer[] - `matched_card_in` integer[] - `matched` boolean - `confidence_gte` number, float - `bs_type` string[] - `line` integer[] - `line_crossing_direction` LineCrossingDirectionEnum[] - `backward_line_crossing` boolean - `category_confidence_gte` number, float - `category_confidence_lte` number, float - `category_type` string[] - `color` string[] - `body` string[] - `make` string[] - `model` string[] - `license_plate_number` string[] - `license_plate_number_color` string[] - `license_plate_number_color_confidence_lte` number, float - `license_plate_number_color_confidence_gte` number, float - `license_plate_country` string[] - `license_plate_region` string[] - `special_vehicle_type` string[] - `weight_type` string[] - `weight_type_confidence_lte` number, float - `weight_type_confidence_gte` number, float - `orientation` string[] - `orientation_confidence_lte` number, float - `orientation_confidence_gte` number, float - `human_episodes` HumanEpisodesFilters - `allowed_types` string[] - `matched_lists` integer[] - `cameras` integer[] - `camera_groups` integer[] - `matched_card_in` integer[] - `events_count_gte` integer - `events_count_lte` integer - `face_matched` boolean - `body_matched` boolean - `car_episodes` CarEpisodesFilters - `allowed_types` string[] - `matched_lists` integer[] - `cameras` integer[] - `camera_groups` integer[] - `matched_card_in` integer[] - `events_count_gte` integer - `events_count_lte` integer - `car_matched` boolean - `counters` CounterFilters - `counter` integer[] - `cameras` integer[] - `camera_groups` integer[] - `faces_count_gte` integer - `faces_count_lte` integer - `silhouettes_count_gte` integer - `silhouettes_count_lte` integer - `cars_count_gte` integer - `cars_count_lte` integer - `proximity_min_lte` number, float - `proximity_min_gte` number, float - `proximity_avg_lte` number, float - `proximity_avg_gte` number, float - `proximity_max_lte` number, float - `proximity_max_gte` number, float - `areas` AreasFilters - `area_in` integer[] - `camera_in` integer[] - `camera_group_in` integer[] - `send_attempts` integer — Maximum number of attempts to send a webhook - `created_by` integer, required — Creator ID - `created_date` string, date-time, required — Webhook creation date - `modified_date` string, date-time, required — Webhook modification date --- [API](https://skmtc.dev/ntechlab/apis/internal-api-documentation.md) · [All operations](https://skmtc.dev/ntechlab/apis/internal-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ntechlab/internal-api-documentation/revisions/fe217a895bc7/schema)