Skip to main content
POST
Create public integration

Restrictions

Usage

  • plugin_type must be one of the types listed by POST /integration/type/list with supports_api_create: true; anything else returns InvalidParameter.
  • A type whose status is disabled returns InvalidParameter; a type not included in the account’s plan returns NoLicense.
  • These APIs manage public (account-level) integrations only, not channel-owned dedicated integrations.
  • An omitted integration_key is generated automatically; a supplied key must satisfy the length, account suffix, and uniqueness checks.
  • With is_test: true, inspect test.success; an HTTP 200 response alone does not establish that the plugin test succeeded.
  • Every call is recorded in the account audit log.

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

Payload for creating an integration.

plugin_type
string
required

Integration type. Must be one listed by POST /integration/type/list with supports_api_create: true.

Example:

"standard.alert"

name
string

Integration name, 2–49 characters when nonempty; defaults to the integration type name when omitted or empty.

Required string length: 2 - 49
Example:

"Prod metrics alerts"

description
string

Free-form description, at most 499 characters.

Maximum string length: 499
team_id
integer<int64>

Owning team ID; omit or use 0 for no team. A nonzero ID must belong to the current account.

Required range: x >= 0
Example:

1467226103121

settings
object

Type-specific configuration; the accepted keys depend on plugin_type.

integration_key
string

Optional pre-generated key: 35 characters, ending with the account ID modulo 1000 padded to three digits; it must not already be in use. Omit to generate a key.

Required string length: 35
is_test
boolean

Run the plugin test during creation; false when omitted. Inspect the returned test.success for the test outcome.

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

The created integration and its key.