Skip to main content
POST
Create or update alert pipeline

Restrictions

Usage

  • Replaces the integration’s whole rule list with rules; an empty array removes every rule. At most 50 rules.
  • Rules run in array order on each incoming event of the integration before it becomes an alert; alert_drop, or an alert_inhibit that matches, discards the event and stops processing.
  • integration_id may be an account-level or a channel-owned integration; an ID not in the account returns InvalidParameter.
  • Write access also requires object permission: the account owner, an administrator, the integration creator, or a member of its team (for a channel-owned integration, a member of the channel’s team); with no team, any caller with the API permission may write.
  • An alert_inhibit rule requires the Standard plan or higher; otherwise the call returns NoLicense.
  • On success the response carries only request_id; the data field is omitted.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
integration_id
integer<int64>
required

ID of the integration to configure; account-level and channel-owned integrations are both accepted.

rules
object[]
required

Rules to apply, evaluated in array order. At most 50 entries; an empty array removes all rules.

Maximum array length: 50

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.