Webhook Events

Event Types

Event Types are the top level event on a Webhook response object.

All Event Types that can be received are as follows.

type EventType = 'config_update' | 'status_update'

config_update: will be sent if some partner has updated their alerts configuration
status_update: will be sent as a response to some ticket action being performed against our API.

Events

Events are some event that happened based on some ticket action that was take against out alerts API. Such as ticket creation, ticket appending and more.

enum AuditTrailEventType {
    ALERTS_DISABLED = "Alerts Disabled",
    ALERT_RECEIVED = "Alert Received",
    VENDOR_ACCOUNT_FOUND = "Vendor Account Found",
    ACCOUNT_SELECTED = "Account Selected",
    ACCOUNT_NOT_FOUND = "Account Not Found",
    ACCOUNT_NOT_MAPPED = "Account Not Mapped",
    INTEGRATION_NOT_CONFIGURED = "Integration Not Configured",
    INTEGRATION_DELETED = "Integration Deleted",
    NO_RULES_DEFINED = "Ruleset Not Found",
    RULE_DELETED = "Rule was deleted",
    RULES_FOUND = "Ruleset Found",
    ALL_RULES_DISABLED = "Rules Disabled For Service",
    PRODUCT_GROUP_FOUND = "Product Group Found",
    PRODUCT_GROUP_NOT_FOUND = "Product Group Not Found",
    RULE_SELECTED = "Rule Selected",
    TICKET_SENT = "Ticket Sent",
    TICKET_RESPONSE = "Ticket Response",
    TICKET_CREATION_FAILED = "Failed To Create Ticket",
    TICKET_RETRY = "Ticket Retry",
    TICKET_CREATED = "Ticket Created",
    TICKET_PATCH_RECEIVED = "Ticket Update Received",
    TICKET_UPDATE_SENT = "Ticket Note Update Sent",
    TICKET_UPDATED = "Ticket Updated",
    TICKED_UPDATE_FAILED = "Ticket Update Failed",
    TICKET_LOG_NOT_FOUND_APPEND = "Ticket Not Found",
    TICKET_RESOLUTION_SENT = "Ticket Resolution Sent",
    TICKET_RESOLUTION_SUCCESSFUL = "Ticket Resolution Sucessful",
    TICKET_RESOLUTION_FAILED = "Ticket Resolution Failed"
}

Ticket Status

type TicketStatus = 'created' | 'failed' | 'retrying' | 'suppressed' | 'appended' | 'resolved';