Skip to main content
POST
Execute custom action

Restrictions

Usage

  • The integration must be an enabled custom action integration whose channels include the incident’s channel; otherwise the call fails with InvalidParameter.
  • The server posts the incident payload to the action’s URL with a 2-second timeout. If that request fails, the call still returns HTTP 200 with the error in data.message; on success data is null.
  • A successful run adds an i_custom timeline entry.

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

Parameters for invoking a custom action integration on an incident.

incident_id
string
required

Incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
integration_id
integer<int64>
required

Custom action integration ID. Must be enabled and associated with the incident's channel.

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 | null

null when the action's HTTP request succeeded; an object with message when it failed.