Webhook

A Webhook is a plugin instance receiving data from external monitoring systems.

Package : spaceone.api.monitoring.v1

Webhook

Webhook Methods:

Method	Request	Response
create	CreateWebhookRequest	WebhookInfo
update	UpdateWebhookRequest	WebhookInfo
update_plugin	UpdateWebhookPluginRequest	WebhookInfo
verify_plugin	WebhookRequest	google.protobuf.Empty
enable	WebhookRequest	WebhookInfo
disable	WebhookRequest	WebhookInfo
delete	WebhookRequest	google.protobuf.Empty
get	GetWebhookRequest	WebhookInfo
list	WebhookQuery	WebhooksInfo
stat	WebhookStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/webhooks

Creates a new Webhook. A Webhook collects data from an external monitoring system with a webhook URL generated by the resource.

Type	Message
Request	CreateWebhookRequest
Response	WebhookInfo

Request Example

{
    "name": "aws-sns-webhook-for-phd",
    "plugin_info": {
        "plugin_id": "plugin-aws-sns-mon-webhook",
        "options": {}
    },
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "webhook_id": "webhook-123456789012",
    "name": "aws-sns-webhook-for-phd",
    "state": "ENABLED",
    "access_key": "1234567890123456789012345678901",
    "webhook_url": "https://spaceone.dev/monitoring/v1/webhook/webhook-123456789012/1234567890123456789012345678901/events",
    "capability": {},
    "plugin_info": {
        "plugin_id": "plugin-aws-sns-mon-webhook",
        "version": "1.2.2",
        "options": {},
        "metadata": {},
        "upgrade_mode": "AUTO"
    },
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T07:23:33.875Z"
}

update

PUT /monitoring/v1/webhook/{webhook_id}

Updates a specific Webhook. You can make changes in Webhook settings, including the name and tags.

Type	Message
Request	UpdateWebhookRequest
Response	WebhookInfo

Request Example

{
    "webhook_id": "webhook-123456789012",
    "name": "aws-sns-webhook-for-cloudwatch",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "webhook_id": "webhook-123456789012",
    "name": "aws-sns-webhook-for-cloudwatch",
    "state": "ENABLED",
    "access_key": "1234567890123456789012345678901",
    "webhook_url": "https://spaceone.dev/monitoring/v1/webhook/webhook-123456789012/1234567890123456789012345678901/events",
    "capability": {},
    "plugin_info": {
        "plugin_id": "plugin-aws-sns-mon-webhook",
        "version": "1.2.2",
        "options": {},
        "metadata": {},
        "upgrade_mode": "AUTO"
    },
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T07:23:33.875Z"
}

update_plugin

PUT /monitoring/v1/webhook/{webhook_id}/plugin

Type	Message
Request	UpdateWebhookPluginRequest
Response	WebhookInfo

verify_plugin

POST /monitoring/v1/webhook/{webhook_id}/plugin/verify

Verifies a specific plugin for a Webhook.

Type	Message
Request	WebhookRequest
Response	google.protobuf.Empty

Request Example

{
    "webhook_id": "webhook-123456789012",
    "domain_id": "domain-123456789012"
}

enable

PUT /monitoring/v1/webhook/{webhook_id}/enable

Enables a specific Webhook. By enabling a Webhook, you can communicate with an external application.

Type	Message
Request	WebhookRequest
Response	WebhookInfo

Request Example

{
    "webhook_id": "webhook-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "webhook_id": "webhook-123456789012",
    "name": "aws-sns-webhook-for-cloudwatch",
    "state": "ENABLED",
    "access_key": "1234567890123456789012345678901",
    "webhook_url": "https://monitoring-webhook.dev.spaceone.dev/monitoring/v1/webhook/webhook-123456789012/1234567890123456789012345678901/events",
    "capability": {},
    "plugin_info": {
        "plugin_id": "plugin-aws-sns-mon-webhook",
        "version": "1.2.2",
        "options": {},
        "metadata": {},
        "upgrade_mode": "AUTO"
    },
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T07:23:33.875Z"
}

disable

PUT /monitoring/v1/webhook/{webhook_id}/disable

Disables a specific Webhook. By disabling a Webhook, you cannot communicate with an external application, as the webhook URL from the Webhook becomes invalid.

Type	Message
Request	WebhookRequest
Response	WebhookInfo

Request Example

{
    "webhook_id": "webhook-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "webhook_id": "webhook-123456789012",
    "name": "aws-sns-webhook-for-cloudwatch",
    "state": "DISABLED",
    "access_key": "1234567890123456789012345678901",
    "webhook_url": "https://monitoring-webhook.dev.spaceone.dev/monitoring/v1/webhook/webhook-123456789012/1234567890123456789012345678901/events",
    "capability": {},
    "plugin_info": {
        "plugin_id": "plugin-aws-sns-mon-webhook",
        "version": "1.2.2",
        "options": {},
        "metadata": {},
        "upgrade_mode": "AUTO"
    },
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T07:23:33.875Z"
}

delete

DELETE /monitoring/v1/webhook/{webhook_id}

Deletes a specific Webhook. By deleting a Webhook, you cannot collect data from an external monitoring system, as the REST URL is also deleted.

Type	Message
Request	WebhookRequest
Response	google.protobuf.Empty

Request Example

{
    "webhook_id": "webhook-123456789012",
    "domain_id": "domain-123456789012"
}

get

GET /monitoring/v1/webhook/{webhook_id}

Gets a specific Webhook. Prints detailed information about the Webhook, including the name, the version, and the created datetime.

Type	Message
Request	GetWebhookRequest
Response	WebhookInfo

Request Example

{
    "webhook_id": "webhook-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "webhook_id": "webhook-123456789012",
    "name": "aws-sns-webhook-for-cloudwatch",
    "state": "ENABLED",
    "access_key": "1234567890123456789012345678901",
    "webhook_url": "https://monitoring-webhook.dev.spaceone.dev/monitoring/v1/webhook/webhook-123456789012/1234567890123456789012345678901/events",
    "capability": {},
    "plugin_info": {
        "plugin_id": "plugin-aws-sns-mon-webhook",
        "version": "1.2.2",
        "options": {},
        "metadata": {},
        "upgrade_mode": "AUTO"
    },
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T07:23:33.875Z"
}

list

GET /monitoring/v1/webhooks

POST /monitoring/v1/webhooks/search

Gets a list of all Webhooks. You can use a query to get a filtered list of Webhooks.

Type	Message
Request	WebhookQuery
Response	WebhooksInfo

Request Example

{
    "query": {},
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "results": [
        {
            "webhook_id": "webhook-123456789012",
            "name": "aws-sns-webhook-for-cloudwatch",
            "state": "ENABLED",
            "access_key": "1234567890123456789012345678901",
            "webhook_url": "https://monitoring-webhook.dev.spaceone.dev/monitoring/v1/webhook/webhook-123456789012/1234567890123456789012345678901/events",
            "capability": {},
            "plugin_info": {
                "plugin_id": "plugin-aws-sns-mon-webhook",
                "version": "1.2.2",
                "options": {},
                "metadata": {},
                "upgrade_mode": "AUTO"
            },
            "project_id": "project-123456789012",
            "domain_id": "domain-123456789012",
            "created_at": "2022-01-01T07:23:33.875Z"
        },
        {
            "webhook_id": "webhook-987654321098",
            "name": "zabbix-webhook",
            "state": "ENABLED",
            "access_key": "9876567890123456789012345678901",
            "webhook_url": "https://monitoring-webhook.dev.spaceone.dev/monitoring/v1/webhook/webhook-987654321098/9876567890123456789012345678901/events",
            "capability": {},
            "plugin_info": {
                "plugin_id": "plugin-zabbix-mon-webhook",
                "version": "1.0",
                "options": {},
                "metadata": {},
                "upgrade_mode": "AUTO"
            },
            "project_id": "project-123456789012",
            "domain_id": "domain-123456789012",
            "created_at": "2022-01-01T07:42:31.872Z"
        }
    ],
    "total_count": 2
}

stat

POST /monitoring/v1/webhooks/stat

Type	Message
Request	WebhookStatQuery
Response	google.protobuf.Struct

Message

CreateWebhookRequest

Field	Type	Required	Description
name	string	✔
plugin_info	WebhookPluginInfo	✔
tags	google.protobuf.Struct	✘
project_id	string	✔
domain_id	string	✔

GetWebhookRequest

Field	Type	Required	Description
webhook_id	string	✔
domain_id	string	✔
only	list of string	✘

UpdateWebhookPluginRequest

Field	Type	Required	Description
webhook_id	string	✔
version	string	✘
options	google.protobuf.Struct	✘
upgrade_mode	NONE MANUAL AUTO	✘
domain_id	string	✔

UpdateWebhookRequest

Field	Type	Required	Description
webhook_id	string	✔
name	string	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

WebhookInfo

Field	Type	Description
webhook_id	string
name	string
state	NONE ENABLED DISABLED
access_key	string
webhook_url	string
capability	google.protobuf.Struct
plugin_info	WebhookPluginInfo
tags	google.protobuf.Struct
project_id	string
domain_id	string
created_at	string

WebhookPluginInfo

Field	Type	Description
plugin_id	string
version	string
options	google.protobuf.Struct
metadata	google.protobuf.Struct
upgrade_mode	NONE MANUAL AUTO

WebhookQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
webhook_id	string	✘
name	string	✘
state	NONE ENABLED DISABLED	✘
access_key	string	✘
webhook_url	string	✘
project_id	string	✘
domain_id	string	✔

WebhookRequest

Field	Type	Required	Description
webhook_id	string	✔
domain_id	string	✔

WebhookStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

WebhooksInfo

Field	Type	Description
results	list of WebhookInfo
total_count	int32