All URIs are relative to https://api.evident.io
| Method | HTTP request | Description |
|---|---|---|
| create | POST /api/v2/integrations/webhook.json_api | Create a Webhook Integration |
| show | GET /api/v2/integrations/{integration_id}/webhook.json_api | Show a single Webhook Integration |
| update | PATCH /api/v2/integrations/{integration_id}/webhook.json_api | Update a Webhook Integration |
IntegrationWebhook create(external_account_ids, name, throttle_rate, url, opts)
Create a Webhook Integration
# load the gem
require 'esp_sdk'
api_instance = ESP::IntegrationsWebhookApi.new
external_account_ids = [56] # Array<Integer> | External accounts for integration
name = "name_example" # String | Name of the integration
throttle_rate = 56 # Integer | The maximum number of alerts that may be sent through the integration every minute.
url = "url_example" # String | The URL endpoint for the webhook
opts = {
include: "include_example", # String | Related objects that can be included in the response: integration See Including Objects for more information.
all_high_risk: true, # BOOLEAN | Send all high risk alerts
all_low_risk: true, # BOOLEAN | Send all low risk alerts
all_medium_risk: true, # BOOLEAN | Send all medium risk alerts
custom_signature_ids: [56], # Array<Integer> | Custom signatures for integration
send_updates: true, # BOOLEAN | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
send_when_suppressed: true, # BOOLEAN | Send notifications for suppressed alerts
signature_ids: [56], # Array<Integer> | Signatures for integration
statuses: ["statuses_example"] # Array<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
}
begin
#Create a Webhook Integration
result = api_instance.create(external_account_ids, name, throttle_rate, url, opts)
p result
rescue ESP::ApiError => e
puts "Exception when calling IntegrationsWebhookApi->create: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| external_account_ids | Array<Integer> | External accounts for integration | |
| name | String | Name of the integration | |
| throttle_rate | Integer | The maximum number of alerts that may be sent through the integration every minute. | |
| url | String | The URL endpoint for the webhook | |
| include | String | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| all_high_risk | BOOLEAN | Send all high risk alerts | [optional] |
| all_low_risk | BOOLEAN | Send all low risk alerts | [optional] |
| all_medium_risk | BOOLEAN | Send all medium risk alerts | [optional] |
| custom_signature_ids | Array<Integer> | Custom signatures for integration | [optional] |
| send_updates | BOOLEAN | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. | [optional] |
| send_when_suppressed | BOOLEAN | Send notifications for suppressed alerts | [optional] |
| signature_ids | Array<Integer> | Signatures for integration | [optional] |
| statuses | Array<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
IntegrationWebhook show(integration_id, opts)
Show a single Webhook Integration
# load the gem
require 'esp_sdk'
api_instance = ESP::IntegrationsWebhookApi.new
integration_id = 56 # Integer | The ID of the integration
opts = {
include: "include_example" # String | Related objects that can be included in the response: integration See Including Objects for more information.
}
begin
#Show a single Webhook Integration
result = api_instance.show(integration_id, opts)
p result
rescue ESP::ApiError => e
puts "Exception when calling IntegrationsWebhookApi->show: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| integration_id | Integer | The ID of the integration | |
| include | String | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
IntegrationWebhook update(integration_id, opts)
Update a Webhook Integration
# load the gem
require 'esp_sdk'
api_instance = ESP::IntegrationsWebhookApi.new
integration_id = 56 # Integer | The ID of the integration
opts = {
include: "include_example", # String | Related objects that can be included in the response: integration See Including Objects for more information.
all_high_risk: true, # BOOLEAN | Send all high risk alerts
all_low_risk: true, # BOOLEAN | Send all low risk alerts
all_medium_risk: true, # BOOLEAN | Send all medium risk alerts
custom_signature_ids: [56], # Array<Integer> | Custom signatures for integration
external_account_ids: [56], # Array<Integer> | External accounts for integration
name: "name_example", # String | Name of the integration
send_updates: true, # BOOLEAN | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
send_when_suppressed: true, # BOOLEAN | Send notifications for suppressed alerts
signature_ids: [56], # Array<Integer> | Signatures for integration
statuses: ["statuses_example"], # Array<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
throttle_rate: 56, # Integer | The maximum number of alerts that may be sent through the integration every minute.
url: "url_example" # String | The URL endpoint for the webhook
}
begin
#Update a Webhook Integration
result = api_instance.update(integration_id, opts)
p result
rescue ESP::ApiError => e
puts "Exception when calling IntegrationsWebhookApi->update: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| integration_id | Integer | The ID of the integration | |
| include | String | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| all_high_risk | BOOLEAN | Send all high risk alerts | [optional] |
| all_low_risk | BOOLEAN | Send all low risk alerts | [optional] |
| all_medium_risk | BOOLEAN | Send all medium risk alerts | [optional] |
| custom_signature_ids | Array<Integer> | Custom signatures for integration | [optional] |
| external_account_ids | Array<Integer> | External accounts for integration | [optional] |
| name | String | Name of the integration | [optional] |
| send_updates | BOOLEAN | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. | [optional] |
| send_when_suppressed | BOOLEAN | Send notifications for suppressed alerts | [optional] |
| signature_ids | Array<Integer> | Signatures for integration | [optional] |
| statuses | Array<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
| throttle_rate | Integer | The maximum number of alerts that may be sent through the integration every minute. | [optional] |
| url | String | The URL endpoint for the webhook | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json