keon94 commented on code in PR #246: URL: https://github.com/apache/incubator-devlake-website/pull/246#discussion_r992792615
########## docs/Plugins/webhook.md: ########## @@ -42,35 +34,37 @@ If you want to collect issue or incident data from your system, you can use the `POST https://sample-url.com/api/plugins/webhook/1/issues` -needs to be called when an issue or incident is created. The body includes columns as follows: - -``` -board_key: issue belongs to which board/project -url(Optional): issue's URL -issue_key: issue's key, needs to be unique in a connection -title -description(Optional) -epic_key(Optional): in which epic. -type(Optional): type, such as bug/incident/epic/... -status: issue's status. Must be one of TODO DONE IN_PROGRESS -original_status: status in your system, such as created/open/closed/... -story_point(Optional) -resolution_date(Optional): date, Format should be 2020-01-01T12:00:00+00:00 -created_date: date, Format should be 2020-01-01T12:00:00+00:00 -updated_date(Optional): date, Format should be 2020-01-01T12:00:00+00:00 -lead_time_minutes(Optional): how long from this issue accepted to develop -parent_issue_key(Optional) -priority(Optional) -original_estimate_minutes(Optional) -time_spent_minutes(Optional) -time_remaining_minutes(Optional) -creator_id(Optional): the user id of the creator -creator_name(Optional): the user name of the creator, it will just be used to display -assignee_id(Optional) -assignee_name(Optional) -severity(Optional) -component(Optional): which component is this issue in. -``` +needs to be called when an issue or incident is created. The body should be a JSON and include columns as follows: + +| Keyname | Require | Notes | Review Comment: I think it's better if the column name is "Required", and the values are Yes/No -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
