{"id":22671546,"url":"https://github.com/cloudforet-io/plugin-api-direct-mon-webhook","last_synced_at":"2025-04-12T12:23:40.393Z","repository":{"id":61673190,"uuid":"532700347","full_name":"cloudforet-io/plugin-api-direct-mon-webhook","owner":"cloudforet-io","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-21T16:36:50.000Z","size":76,"stargazers_count":4,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-03-21T17:48:15.143Z","etag":null,"topics":["monitoring","plugin","webhook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudforet-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-09-05T01:11:05.000Z","updated_at":"2022-09-14T09:44:44.000Z","dependencies_parsed_at":"2024-03-21T17:53:47.479Z","dependency_job_id":"03850588-c5ed-4059-adb7-f3ca9da2b7d2","html_url":"https://github.com/cloudforet-io/plugin-api-direct-mon-webhook","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fplugin-api-direct-mon-webhook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fplugin-api-direct-mon-webhook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fplugin-api-direct-mon-webhook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudforet-io%2Fplugin-api-direct-mon-webhook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudforet-io","download_url":"https://codeload.github.com/cloudforet-io/plugin-api-direct-mon-webhook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228920522,"owners_count":17992005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["monitoring","plugin","webhook"],"created_at":"2024-12-09T16:15:32.927Z","updated_at":"2024-12-09T16:15:36.879Z","avatar_url":"https://github.com/cloudforet-io.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eWebhook plugin for SpaceONE\u003c/h1\u003e  \n\n\u003cbr/\u003e  \n\u003cdiv align=\"center\" style=\"display:flex;\"\u003e  \n  \u003cimg width=\"245\" src=\"https://user-images.githubusercontent.com/35549653/76694897-de236300-66bb-11ea-9ace-b9edde9c12da.png\"\u003e  \n  \u003cp\u003e \n   \u003cbr\u003e\n    \u003cimg  alt=\"Version\"  src=\"https://img.shields.io/badge/version-1.2.5-blue.svg?cacheSeconds=2592000\"  /\u003e    \n    \u003ca  href=\"https://www.apache.org/licenses/LICENSE-2.0\"  target=\"_blank\"\u003e  \n        \u003cimg  alt=\"License: Apache 2.0\"  src=\"https://img.shields.io/badge/License-Apache 2.0-yellow.svg\"  /\u003e  \n    \u003c/a\u003e \n    \u003c/p\u003e \n\u003c/div\u003e    \n\n\n\n\u003e SpaceONE's [plugin-api-direct-mon-webhook](https://github.com/spaceone-dev/plugin-api-direct-mon-webhook) \n is a tool that can integrate and manage events of from 3rd-party system.   \n\u003e SpaceONE already supports various external monitoring ecosystems in the form of plug-ins   \n\u003e If you want to integrate SpaceONE with the monitoring system you are operated, deliver the events to this plugin webhook.\n\nFind us also at [Dockerhub](https://hub.docker.com/repository/docker/spaceone/plugin-api-direct-mon-webhook)\n\u003e Latest stable version : 1.2.5\n\nPlease contact us if you need any further information. (support@spaceone.dev)\n\n---\n\n## Body of the request\n\n```json\n{\n    \"options\": {},\n    \"data\": {\n        \"event_key\": \"xa339sa9b09sd94jgx1234vlkajdflk\",\n        \"event_type\": \"ALERT\",\n        \"title\": \"This is test event\",\n        \"description\": \"This is Sample Event. It's sample description.\",\n        \"severity\": \"ERROR\",\n        \"rule\": \"this is event rule\",\n        \"image_url\": \"https://sample.io/img/sdfsdf\",\n        \"provider\": \"aws\",\n        \"account\": \"aws-account-id\",\n        \"resource\": {\n            \"resource_id\": \"resource-xzasdfasdf\",\n            \"resource_type\": \"server\",\n            \"name\": \"resource_name\"\n        },\n        \"additional_info\": {\n            \"asdlkafjsdlkf\": \"asdfasdf\"\n        },\n        \"occurred_at\": \"datetime\"\n    }\n}\n```\n\n| **Parameter**            | **Description**      | **Examples**  |\n|--------------------------| -------------------- | ------------- | \n| `event_key`              | event unique key     | |\n| `event_type`             | Type of event.       | `RECOVERY`, `ALERT`, `ERROR` |\n| `title`                  | Title of event       | |\n| `description`            | Description of event | |\n| `severity`               | Severity of event    | `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `NOT_AVAILABLE` |\n| `rule`                   | Rule in which the event was triggered                  | |\n| `image_url`              | URL include the image associated with the event        | |\n| `provider`               | Provider of the resource which the event was generated | |\n| `account`                | Account ID of the resource which the event was generated| |\n| `resource.resource_id`   | ID of the resource which the event was generated       | |\n| `resource.resource_type` | The type of the resource which the event was generated | |\n| `resource.name`          | Name of resource | |\n| `additional_info`        | Additional information about the event. It is a dictionary type, and both key and value must be string type.| |\n| `occurred_at`            | Time when the event occurred. | |\n---\n\n## Supported options\n### load_json\nLoad the json in the data of the request.\n```json\n{\n    \"options\": {\n        \"load_json\": [\n            \"Message\",\n            \"AdditionalInfo\"\n        ]\n    }\n}\n```\n\n### convert_data\nConvert the data of the request using the jinja2 template.\n```json\n{\n    \"options\": {\n        \"convert_data\": {\n           \"event_key\": \"{{ Message.id }}\",\n           \"title\": \"{{ Message.detail.EventID }}\",\n           \"account\": \"{{ Message.account }}\",\n           \"resource\": {\n               \"resource_id\": \"{{ Message.detail.SourceArn }}\"\n           },\n           \"occurred_at\": \"{{ Message.detail.Date }}\"\n       }\n    }\n}\n```\n\n### confirm_url\nConfirm the URL of the webhook.\n```json\n{\n    \"options\": {\n        \"confirm_url\": \"SubscribeURL\"\n    }\n}\n```\n\n## Release note\n\n### Ver 1.2.5\nEnhancement\n- Add option to confirm the URL of the webhook\n\n### Ver 1.2.4\nEnhancement\n- Add option to load json in the data of the request\n- Add option to convert the data of the request using the jinja2 template\n\n### Ver 1.1\nEnhancement\n- Add validation in API Direct Webhook [#7](https://github.com/spaceone-dev/plugin-api-direct-mon-webhook/issues/7)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudforet-io%2Fplugin-api-direct-mon-webhook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudforet-io%2Fplugin-api-direct-mon-webhook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudforet-io%2Fplugin-api-direct-mon-webhook/lists"}