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

Quick Start

FlashDuty supports pushing real-time incident and alert changes to third-party systems, such as ticket platforms or incident auto-healing systems, enabling information synchronization and accelerating incident resolution.

Webhook Types#

1.
Incident Webhook: Push notifications when incident changes occur
2.
Alert Webhook: Push notifications when alert changes occur

Webhook Subscription#

You can add Webhook instances by going to the Console - Integration Center - Webhook page.

Push Method#

Currently, only HTTP/HTTPS protocol with POST method is supported, and the request payload must be in JSON format.
For example, if your service URL is https://example.com/webhook?a=a, the actual push request would be:

Headers#

We support pushing with custom-defined Headers. Note that Headers must be unique within a Webhook.

Event Scope#

You can specify to subscribe to events from a specific channel, and filter event types. Note that incident and alert event types are different, please refer to the corresponding documentation for details.

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.
Will pushes continue after a failed push?
Currently, FlashDuty pushes at most once. A retry mechanism may be introduced in the future, and retries may also occur due to middleware timeouts. You need to handle idempotency properly.
3.
How is push order guaranteed?
In theory, events for the same alert are pushed in chronological order, but retries and other situations may cause out-of-order delivery;
The service can filter based on event_time. If a later event has been received, earlier events can be filtered out. Each push carries the latest and complete information, occasional event loss is tolerable.
4.
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
Change Event
Next
Custom Actions
Built with