Skip to main content

Module api

Module api 

Source

Modules§

alert_message_fields
alert_type
create_integration_details
create_integration_request
create_opsgenie_integration_details
create_pager_duty_integration_details
create_secure_webhook_integration_request
create_secure_webhook_integration_response
create_simple_webhook_details
create_teams_webhook_integration_details
generate_slack_webhook_response
integration
integration_details
integration_rid
internal_send_message_request
message_fields
notification_configuration
notification_filter
opsgenie_integration
opsgenie_region
pager_duty_integration
resolution_failure_message_fields
rotate_webhook_signing_key_response
secure_webhook_integration
send_message_request
send_secure_webhook_message_request
send_secure_webhook_message_response
simple_webhook_integration
slack_instance_type
slack_webhook_integration
teams_webhook_integration
update_integration_details
update_integration_details_request
update_integration_request
update_opsgenie_integration_details
update_pager_duty_integration_details
update_secure_webhook_integration_details
update_simple_webhook_details
update_teams_webhook_integration_details
webhook_delivery_config

Structs§

AlertMessageFields
CreateIntegrationRequest
CreateOpsgenieIntegrationDetails
CreatePagerDutyIntegrationDetails
CreateSecureWebhookIntegrationRequest
Configuration for creating an advanced webhook integration. Signing key is generated by the server.
CreateSecureWebhookIntegrationResponse
Response returned when creating a webhook integration. Contains the full integration object and the server-generated HMAC signing key. The signing key is only returned at creation time — store it securely.
CreateSimpleWebhookDetails
CreateTeamsWebhookIntegrationDetails
GenerateSlackWebhookResponse
Integration
Configuration details used to connect to an external service.
IntegrationRid
InternalSendMessageRequest
NotificationConfiguration
Configuration details to send notifications to a linked integration.
OpsgenieIntegration
PagerDutyIntegration
ResolutionFailureMessageFields
RotateWebhookSigningKeyResponse
Response when rotating a webhook integration’s signing key. This is the only way to retrieve the signing key after initial creation.
SecureWebhookIntegration
Advanced webhook integration with HMAC signing, custom headers, and configurable defaults.
SendMessageRequest
SendSecureWebhookMessageRequest
Request to send a message via secure webhook with optional per-request overrides. Request overrides take precedence over integration’s stored configuration.
SendSecureWebhookMessageResponse
Response indicating successful webhook delivery. Errors are thrown as exceptions rather than encoded in response.
SimpleWebhookIntegration
SlackWebhookIntegration
TeamsWebhookIntegration
UpdateIntegrationDetailsRequest
UpdateIntegrationRequest
UpdateOpsgenieIntegrationDetails
UpdatePagerDutyIntegrationDetails
UpdateSecureWebhookIntegrationDetails
Configuration for updating an advanced webhook integration. This is a full replacement update - all fields must be provided. Optional retry/timeout fields not provided will be reset to server defaults. Note: To rotate the signing key, use the rotateSecureWebhookIntegrationSigningKey endpoint instead.
UpdateSimpleWebhookDetails
UpdateTeamsWebhookIntegrationDetails
WebhookDeliveryConfig
Retry parameters serve as integration-level defaults that can be overridden at runtime.

Enums§

AlertType
CreateIntegrationDetails
IntegrationDetails
MessageFields
NotificationFilter
Specifies a type of notification to filter.
OpsgenieRegion
Opsgenie region for the account linked to the provided API key.
SlackInstanceType
UpdateIntegrationDetails