Skip to main content
POST
Create a behavior event

Restrictions

Usage

  • Behavior events never rewrite stored data: rules are evaluated at query time, so a new or edited event applies to the whole retention window immediately.
  • name must be unique within the application; a duplicate returns InvalidParameter.
  • A click rule needs both page and element; a custom rule needs name; 1 to 20 rules are allowed, and an application can hold at most 200 events.
  • The 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

Save a new behavior event.

application_id
string
required

RUM application ID. The caller needs read access to it; for write operations, manage access.

name
string
required

Event name, unique per application. 1-128 characters.

Required string length: 1 - 128
rules
object[]
required

Rules of the event. They are OR-ed: a raw action belongs to the event when any rule matches it. 1-20 rules.

Required array length: 1 - 20 elements
description
string

Free-text description, at most 512 bytes.

Maximum string length: 512

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

A saved behavior event: a named rule set evaluated at query time.