Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Webhook
  • Open API
    • Quick Start
    • About Pagination
    • Member Management
      • Invite members
      • Delete member
      • Reset information
      • Member list
    • Team Management
      • Team list
      • Basic information
      • Delete team
      • Team upsert
    • Schedule Management
      • Preview schedule
      • Update schedule
      • Enable schedule
      • Disable schedule
      • Create schedule
      • Delete schedule
      • View schedule details
      • Get schedule information by ID list
      • View schedule list
      • Personal schedule calendar
      • Role information
    • Information Retrieval
      • Channel
      • Member
      • Team
    • Preference Settings
      • View preference settings
      • Modify preference settings
    • Channel
      • Escalation Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Create rule
        • Update rule
      • Subscription Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Drop Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Silence Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Inner conditions
      • Inhibit Rules
        • Disable rule
        • Delete rule
        • Rule list
        • See creation interface for filters explanation
        • Channel ID
        • Rule name
      • Match conditions
      • Delete rule
      • See creation interface for filters explanation
      • Enable rule
      • Update rule
      • Rule ID
      • Rule name
      • Sort
      • Delete rule
      • See creation interface for filters explanation
      • Name by integration
      • Robot list
    • Template Management
      • Name
      • Enable rule
      • Delete rule
      • See creation interface for filters explanation
      • Channel ID
      • Rule name
      • Required when updating
      • Update rule
    • Incident Management
      • Group View
        • Channel
        • Rule name
        • Inner conditions
        • Channel
      • Match conditions
      • Enable rule
      • Disable rule
      • Delete rule
      • Rule list
      • See creation interface for filters explanation
      • Create rule
      • Rule description
      • Update rule
      • Channel
      • Match conditions
      • Match conditions
      • Update rule
      • Channel
      • Rule ID
      • Inner conditions
      • Enable rule
      • Rule list
      • Rule details
      • Rule name
      • Rule description
      • Match conditions
      • Rule description
      • See creation interface for filters explanation
      • Disable rule
      • Rule description
    • Alert Management
      • Group View
        • Required when updating
        • Rule name
        • Inner conditions
        • Disable rule
      • Alert Info
      • Close Alert
      • Alert List By Card
      • Alert List
      • Alert List By ID
      • Event List
      • Feed
      • Merge Incident
    • Change Management
      • Inner conditions
    • Insights (old)
      • Channel
      • Match conditions
      • Rule ID
      • Enable rule
      • Name
      • Disable rule
      • Rule name
      • Name
      • See creation interface for filters explanation
    • Custom Fields
      • Enable rule
      • Disable rule
      • See creation interface for filters explanation
      • Channel ID
      • Channel
    • Service Calendar
      • Match conditions
      • Delete rule
      • Update rule
      • Required when updating
      • Rule details
      • Required when updating
      • Inner conditions
      • Channel
    • Label Enhancement
      • Mapping
        • Rule name
        • Rule list
        • Rule description
        • Match conditions
        • Rule ID
        • Rule description
        • Inner conditions
        • Enable rule
        • Disable rule
        • Rule description
      • Enable rule
      • Delete rule
    • Alert Processing
      • Create rule
      • Rule name
    • Integration Routing
      • Required when updating
      • Rule description
      • Match conditions
    • License Management
      • Create rule
    • Insights
      • Team Metrics
      • Responder Metrics Export
      • Incident List
      • Responder Metrics
      • Account Metrics
      • Channel Metrics Export
      • Team Metrics Export
      • Incident Export
      • Alert Top
      • Cahnnel Metrics
  • Event API
    • Quick Start
    • Alert Event
    • Change Event
  • Webhook
    • Quick Start
    • Custom Actions
    • Alert Webhook
    • Incident Webhook
  1. Webhook

Custom Actions

Configuring incident custom actions allows you to quickly call external interfaces during incident investigation, enabling incident auto-healing, information enrichment, and any other custom operations.

I. Creating Actions#

1.
Log in to the FlashDuty Console and go to [Integration Center - Webhook]
2.
Click to add a Custom Action integration
3.
Configure the action name, which will appear as a button in incident details
4.
Configure channels - you can configure multiple channels, but each channel can have at most three custom actions
5.
Configure Endpoint and custom Headers
6.
Save to complete

II. Push Description#

Request Method#

POST, Content-Type:"application/json"

Request Payload:#

[Detailed payload structure omitted for brevity - identical to the Chinese version]

Response#

HTTP status code 200 indicates successful push.

Request Example#

[Example code omitted for brevity - identical to the Chinese version]

III. Use Cases#

Restart Host#

When host memory or CPU is maxed out, trigger host restart scripts to quickly complete host restart.

Information Enrichment#

When an incident occurs, callback to your service to retrieve Tracing, Logging, topology and other information based on alert details, actively call FlashDuty Open API to update incident information, such as adding labels or setting custom fields to assist troubleshooting.

Rollback Changes#

When an incident occurs, if determined to be caused by changes, directly trigger callback to your deployment platform to initiate rollback process, accelerating incident recovery.

Update Status Page#

When confirmed that an incident affects online services, trigger external status page updates to promptly notify your customers or upstream/downstream dependencies.

IV. Common Questions#

1.
Is there a response timeout for the service?
The service must respond within 1 second, otherwise it will be considered as a failed response
2.
Trusted IP whitelist for push sources?
47.94.95.118, 123.56.8.183, 47.94.193.81, 1.13.19.96
May be updated in the future, please check periodically
Previous
Quick Start
Next
Alert Webhook
Built with