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, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses)
Create a Webhook Integration
from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = esp_sdk.IntegrationsWebhookApi()
external_account_ids = [56] # list[int] | External accounts for integration
name = 'name_example' # str | Name of the integration
throttle_rate = 56 # int | The maximum number of alerts that may be sent through the integration every minute.
url = 'url_example' # str | The URL endpoint for the webhook
include = 'include_example' # str | Related objects that can be included in the response: integration See Including Objects for more information. (optional)
all_high_risk = true # bool | Send all high risk alerts (optional)
all_low_risk = true # bool | Send all low risk alerts (optional)
all_medium_risk = true # bool | Send all medium risk alerts (optional)
custom_signature_ids = [56] # list[int] | Custom signatures for integration (optional)
send_updates = true # bool | 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 = true # bool | Send notifications for suppressed alerts (optional)
signature_ids = [56] # list[int] | Signatures for integration (optional)
statuses = ['statuses_example'] # list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info (optional)
try:
# Create a Webhook Integration
api_response = api_instance.create(external_account_ids, name, throttle_rate, url, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsWebhookApi->create: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| external_account_ids | list[int] | External accounts for integration | |
| name | str | Name of the integration | |
| throttle_rate | int | The maximum number of alerts that may be sent through the integration every minute. | |
| url | str | The URL endpoint for the webhook | |
| include | str | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| all_high_risk | bool | Send all high risk alerts | [optional] |
| all_low_risk | bool | Send all low risk alerts | [optional] |
| all_medium_risk | bool | Send all medium risk alerts | [optional] |
| custom_signature_ids | list[int] | Custom signatures for integration | [optional] |
| send_updates | bool | 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 | bool | Send notifications for suppressed alerts | [optional] |
| signature_ids | list[int] | Signatures for integration | [optional] |
| statuses | list[str] | 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-python#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IntegrationWebhook show(integration_id, include=include)
Show a single Webhook Integration
from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = esp_sdk.IntegrationsWebhookApi()
integration_id = 56 # int | The ID of the integration
include = 'include_example' # str | Related objects that can be included in the response: integration See Including Objects for more information. (optional)
try:
# Show a single Webhook Integration
api_response = api_instance.show(integration_id, include=include)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsWebhookApi->show: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| integration_id | int | The ID of the integration | |
| include | str | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IntegrationWebhook update(integration_id, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, external_account_ids=external_account_ids, name=name, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, throttle_rate=throttle_rate, url=url)
Update a Webhook Integration
from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = esp_sdk.IntegrationsWebhookApi()
integration_id = 56 # int | The ID of the integration
include = 'include_example' # str | Related objects that can be included in the response: integration See Including Objects for more information. (optional)
all_high_risk = true # bool | Send all high risk alerts (optional)
all_low_risk = true # bool | Send all low risk alerts (optional)
all_medium_risk = true # bool | Send all medium risk alerts (optional)
custom_signature_ids = [56] # list[int] | Custom signatures for integration (optional)
external_account_ids = [56] # list[int] | External accounts for integration (optional)
name = 'name_example' # str | Name of the integration (optional)
send_updates = true # bool | 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 = true # bool | Send notifications for suppressed alerts (optional)
signature_ids = [56] # list[int] | Signatures for integration (optional)
statuses = ['statuses_example'] # list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info (optional)
throttle_rate = 56 # int | The maximum number of alerts that may be sent through the integration every minute. (optional)
url = 'url_example' # str | The URL endpoint for the webhook (optional)
try:
# Update a Webhook Integration
api_response = api_instance.update(integration_id, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, external_account_ids=external_account_ids, name=name, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, throttle_rate=throttle_rate, url=url)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsWebhookApi->update: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| integration_id | int | The ID of the integration | |
| include | str | Related objects that can be included in the response: integration See Including Objects for more information. | [optional] |
| all_high_risk | bool | Send all high risk alerts | [optional] |
| all_low_risk | bool | Send all low risk alerts | [optional] |
| all_medium_risk | bool | Send all medium risk alerts | [optional] |
| custom_signature_ids | list[int] | Custom signatures for integration | [optional] |
| external_account_ids | list[int] | External accounts for integration | [optional] |
| name | str | Name of the integration | [optional] |
| send_updates | bool | 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 | bool | Send notifications for suppressed alerts | [optional] |
| signature_ids | list[int] | Signatures for integration | [optional] |
| statuses | list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info | [optional] |
| throttle_rate | int | The maximum number of alerts that may be sent through the integration every minute. | [optional] |
| url | str | The URL endpoint for the webhook | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- Content-Type: application/vnd.api+json
- Accept: application/vnd.api+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]