> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a behavior event

> Save a new behavior event from a rule set and return it at version 1.

## Restrictions

| Aspect | Value |
| - | - |
| Rate limits | **300 requests/minute**; **20 requests/second** per account |
| Permissions | **Behavior Analytics Manage** (`rum`) |

## 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.


## OpenAPI

````yaml /api-reference/rum.openapi.en.json post /rum/behavior-event/create
openapi: 3.1.0
info:
  description: >-
    Public HTTP API for the Flashduty incident management platform — incidents,
    notification templates, channels, schedules, monitors, RUM, and platform
    administration. Every operation is authenticated with an `app_key` query
    parameter created in the Flashduty console under My → APP Key (or sent in
    the `Fd-App-Key` header). Responses follow a uniform envelope: `{
    request_id, data }` on success, `{ request_id, error }` on failure.
  title: Flashduty Open API
  version: 1.0.0
servers:
  - description: Flashduty Open API
    url: https://api.flashcat.cloud
security:
  - AppKeyAuth: []
tags:
  - description: Manage Real User Monitoring (RUM) applications.
    name: RUM/Applications
  - description: Run RUM analytics queries over event data.
    name: RUM/Data query
  - description: Query and manage RUM error tracking issues and preset severity rules.
    name: RUM/Issues
  - description: >-
      Query RUM facet fields and their value distributions for building
      analytics filters.
    name: RUM/Facets
  - description: >-
      Manage and query RUM sourcemap files for browser, Android, and iOS error
      symbolication.
    name: RUM/Sourcemaps
  - description: Retrieve session replay metadata and recorded segments for RUM sessions.
    name: RUM/Session replay
  - description: >-
      Configure and inspect the rules that decide which RUM errors get ingested
      and stored for an application, including their edit history.
    name: RUM/Error ingestion rules
  - description: >-
      Manage per-application rules that assign a severity to matching front-end
      errors, plus their evaluation order and change history.
    name: RUM/Issue preset severity rules
  - description: Query the RUM resource record and current usage for the account.
    name: RUM/Resources
  - description: >-
      Create and manage RUM custom dashboards, their revision history and the
      trash.
    name: RUM/Dashboards
  - description: >-
      Define and inspect the behavior events that saved rules turn raw RUM
      actions into.
    name: RUM/Behavior events
  - description: >-
      Analyse conversion funnels over RUM sessions and visitors: results,
      trends, breakdowns, drop-off drivers and page flows.
    name: RUM/Funnels
  - description: >-
      Read page heatmaps: element ranking, click points, scroll depth and the
      replay frame used as background.
    name: RUM/Heatmaps
paths:
  /rum/behavior-event/create:
    post:
      tags:
        - RUM/Behavior events
      summary: Create a behavior event
      description: Save a new behavior event from a rule set and return it at version 1.
      operationId: rum-behavior-event-write-create
      requestBody:
        content:
          application/json:
            example:
              application_id: app_3fK9mQ2xLp7VbN4cR8dW1y
              description: Buyer reached the order confirmation page after paying.
              name: Checkout completed
              rules:
                - element:
                    by: selector
                    op: eq
                    value: '#pay-now'
                  page:
                    op: prefix
                    value: /checkout
                  type: click
                - name: checkout_completed
                  type: custom
            schema:
              $ref: '#/components/schemas/RumBehaviorEventCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  created_at: 1779331200000
                  created_by: 80011
                  description: Buyer reached the order confirmation page after paying.
                  event_id: n3Q8kZvT2mRxW7cLpYbE4a
                  name: Checkout completed
                  rules:
                    - element:
                        by: selector
                        op: eq
                        value: '#pay-now'
                      page:
                        op: prefix
                        value: /checkout
                      type: click
                    - name: checkout_completed
                      type: custom
                  status: enabled
                  updated_at: 1780275600000
                  updated_by: 80042
                  version: 3
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - properties:
                      data:
                        $ref: '#/components/schemas/RumBehaviorEvent'
                    type: object
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    RumBehaviorEventCreateRequest:
      description: Save a new behavior event.
      properties:
        application_id:
          description: >-
            RUM application ID. The caller needs read access to it; for write
            operations, manage access.
          type: string
        description:
          description: Free-text description, at most 512 bytes.
          maxLength: 512
          type: string
        name:
          description: Event name, unique per application. 1-128 characters.
          maxLength: 128
          minLength: 1
          type: string
        rules:
          description: >-
            Rules of the event. They are OR-ed: a raw action belongs to the
            event when any rule matches it. 1-20 rules.
          items:
            $ref: '#/components/schemas/RumBehaviorRule'
          maxItems: 20
          minItems: 1
          type: array
      required:
        - application_id
        - name
        - rules
      type: object
    SuccessEnvelope:
      description: >-
        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`.
      properties:
        data:
          description: >-
            Operation-specific payload, documented in each operation's 200
            response. Operations without a payload return `{}` or omit `data`
            entirely.
        request_id:
          description: >-
            Unique ID for this request. Mirrored in the Flashcat-Request-Id
            response header. Include it when reporting issues.
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          type: string
      required:
        - request_id
      type: object
    RumBehaviorEvent:
      description: 'A saved behavior event: a named rule set evaluated at query time.'
      properties:
        created_at:
          description: Creation time, Unix timestamp in milliseconds.
          format: int64
          type: integer
        created_by:
          description: Person ID of the member who created the event.
          format: int64
          type: integer
        description:
          description: Free-text description, at most 512 bytes.
          maxLength: 512
          type: string
        event_id:
          description: Behavior event ID (a short UUID assigned at creation).
          type: string
        name:
          description: Name of the event, unique per application. 1-128 characters.
          maxLength: 128
          type: string
        rules:
          description: >-
            Rules of the event. They are OR-ed: a raw action belongs to the
            event when any rule matches it. 1-20 rules.
          items:
            $ref: '#/components/schemas/RumBehaviorRule'
          maxItems: 20
          minItems: 1
          type: array
        status:
          description: >-
            Visibility of the event: `enabled` is listed in the console,
            `hidden` keeps it out of the event list while saved funnels may
            still use it. Deleted events are never returned.
          enum:
            - enabled
            - hidden
          type: string
        updated_at:
          description: Last update time, Unix timestamp in milliseconds.
          format: int64
          type: integer
        updated_by:
          description: Person ID of the member who last changed the event.
          format: int64
          type: integer
        version:
          description: >-
            Version of the event; a name or rule change bumps it and keeps the
            previous version in the history.
          type: integer
      required:
        - event_id
        - name
        - description
        - rules
        - status
        - version
        - created_by
        - updated_by
        - created_at
        - updated_at
      type: object
    RumBehaviorRule:
      description: One condition that turns raw actions into a behavior event.
      properties:
        element:
          $ref: '#/components/schemas/RumBehaviorElementMatch'
          description: Clicked element. Required for a `click` rule.
        name:
          description: Action name for a `custom` rule, matched exactly.
          maxLength: 512
          type: string
        page:
          $ref: '#/components/schemas/RumBehaviorMatch'
          description: >-
            Page the click happened on, matched against the page path group.
            Required for a `click` rule.
        type:
          description: >-
            Rule kind: `click` matches an autocaptured click or tap and needs
            both `page` and `element`; `custom` matches the action name reported
            in code through `addAction` and needs `name`.
          enum:
            - click
            - custom
          type: string
      required:
        - type
      type: object
    ErrorResponse:
      description: Response envelope for errors. `error` is required; `data` is absent.
      properties:
        error:
          $ref: '#/components/schemas/DutyError'
        request_id:
          description: >-
            Unique trace ID of this request; include it when reporting issues so
            logs can be located.
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          type: string
      required:
        - request_id
        - error
      type: object
    RumBehaviorElementMatch:
      description: One comparison against the clicked element.
      properties:
        by:
          description: >-
            Which element attribute is compared: `name` the element name the SDK
            reported, `selector` its CSS selector.
          enum:
            - name
            - selector
          type: string
        op:
          description: >-
            How `value` is compared: `eq` exactly, `contains` a substring,
            `prefix` from the start, `regex` a regular expression.
          enum:
            - eq
            - contains
            - prefix
            - regex
          type: string
        value:
          description: >-
            Element name or selector to match. Same length limits as a page
            match value.
          maxLength: 512
          type: string
      required:
        - by
        - op
        - value
      type: object
    RumBehaviorMatch:
      description: One comparison against the page path group.
      properties:
        op:
          description: >-
            How `value` is compared with the page path group: `eq` exactly,
            `contains` a substring, `prefix` from the start, `wildcard` an
            anchored `*` glob, `regex` a regular expression.
          enum:
            - eq
            - contains
            - prefix
            - wildcard
            - regex
          type: string
        value:
          description: >-
            Comparison value. At most 512 bytes without control characters; a
            `regex` value is limited to 200 bytes and must compile.
          maxLength: 512
          type: string
      required:
        - op
        - value
      type: object
    DutyError:
      description: >-
        Error payload inside the response envelope. Present only on non-2xx
        responses.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message in the response language (`locale` /
            `lang` query parameter or `Accept-Language` header). May name the
            offending field; do not parse it.
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
      type: object
    ErrorCode:
      description: >-
        Error code. Every failed response sets `error.code` to one of these
        stable strings; branch on it rather than on the HTTP status.


        | Code | HTTP | Meaning |

        |---|---|---|

        | `OK` | 200 | Reserved; never returned on a failed request. |

        | `InvalidParameter` | 400 | A parameter is missing, has the wrong type,
        or failed validation; `message` usually names the field. |

        | `BadRequest` | 400 | The request breaks a business rule or conflicts
        with the current state of an object; `message` says which. |

        | `InvalidContentType` | 400 | The body is not sent as
        `application/json`. |

        | `ResourceNotFound` | 400 | The referenced object does not exist in
        this account or was deleted. Returned as HTTP 400, not 404. |

        | `NoLicense` | 400 | The account's plan does not include the feature, a
        plan quota is used up, the plan has expired, or credits are
        insufficient. |

        | `ReferenceExist` | 400 | The object is still referenced by other
        objects, so it cannot be deleted. |

        | `Unauthorized` | 401 | The APP Key is missing, invalid, or deleted. |

        | `BalanceNotEnough` | 402 | Console-only (billing); not returned by
        Open API operations. |

        | `AccessDenied` | 403 | The APP Key's permission scope or the creator's
        role does not allow this operation or object. |

        | `RouteNotFound` | 404 | No operation matches the HTTP method and path.
        |

        | `MethodNotAllowed` | 405 | The path exists but not for this HTTP
        method. |

        | `UndonedOrderExist` | 409 | Console-only (billing); not returned by
        Open API operations. |

        | `EntityTooLarge` | 413 | The request body exceeds the size limit. |

        | `RequestLocked` | 423 | Console-only (sign-in protection); not
        returned by Open API operations. |

        | `RequestVerifyRequired` | 428 | Console-only (verification code); not
        returned by Open API operations. |

        | `DangerousOperation` | 428 | Console-only (MFA for high-risk actions);
        not returned by Open API operations. |

        | `RequestTooFrequently` | 429 | A rate limit was hit; wait for the
        `Flashcat-Request-Rate-Limit-Delay` response header (seconds) before
        retrying. |

        | `InternalError` | 500 | Unexpected server error; retry with backoff
        and include `request_id` when reporting. |

        | `ServiceUnavailable` | 503 | A backend dependency is overloaded or
        unavailable; retry with backoff. |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - EntityTooLarge
        - RequestLocked
        - RequestVerifyRequired
        - DangerousOperation
        - RequestTooFrequently
        - InternalError
        - ServiceUnavailable
      example: InvalidParameter
      type: string
      x-enumDescriptions:
        OK: Reserved; never returned on a failed request.
        InvalidParameter: >-
          A parameter is missing, has the wrong type, or failed validation;
          `message` usually names the field.
        BadRequest: >-
          The request breaks a business rule or conflicts with the current state
          of an object; `message` says which.
        InvalidContentType: The body is not sent as `application/json`.
        ResourceNotFound: >-
          The referenced object does not exist in this account or was deleted.
          Returned as HTTP 400, not 404.
        NoLicense: >-
          The account's plan does not include the feature, a plan quota is used
          up, the plan has expired, or credits are insufficient.
        ReferenceExist: >-
          The object is still referenced by other objects, so it cannot be
          deleted.
        Unauthorized: The APP Key is missing, invalid, or deleted.
        BalanceNotEnough: Console-only (billing); not returned by Open API operations.
        AccessDenied: >-
          The APP Key's permission scope or the creator's role does not allow
          this operation or object.
        RouteNotFound: No operation matches the HTTP method and path.
        MethodNotAllowed: The path exists but not for this HTTP method.
        UndonedOrderExist: Console-only (billing); not returned by Open API operations.
        EntityTooLarge: The request body exceeds the size limit.
        RequestLocked: >-
          Console-only (sign-in protection); not returned by Open API
          operations.
        RequestVerifyRequired: Console-only (verification code); not returned by Open API operations.
        DangerousOperation: >-
          Console-only (MFA for high-risk actions); not returned by Open API
          operations.
        RequestTooFrequently: >-
          A rate limit was hit; wait for the `Flashcat-Request-Rate-Limit-Delay`
          response header (seconds) before retrying.
        InternalError: >-
          Unexpected server error; retry with backoff and include `request_id`
          when reporting.
        ServiceUnavailable: A backend dependency is overloaded or unavailable; retry with backoff.
  responses:
    BadRequest:
      content:
        application/json:
          examples:
            missingParameter:
              value:
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Invalid request — usually a missing or malformed parameter.
    Unauthorized:
      content:
        application/json:
          examples:
            missingAppKey:
              value:
                error:
                  code: Unauthorized
                  message: You are unauthorized.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Missing or invalid app_key.
    Forbidden:
      content:
        application/json:
          examples:
            noEditPermission:
              value:
                error:
                  code: AccessDenied
                  message: Access Denied.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: >-
        The app_key is valid, but its permission scope or the creator's role
        does not allow this operation or object.
    TooManyRequests:
      content:
        application/json:
          examples:
            rateLimited:
              value:
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: >-
        Rate limit hit. Wait for the number of seconds in
        `Flashcat-Request-Rate-Limit-Delay`, then retry.
      headers:
        Flashcat-Request-Rate-Limit-Delay:
          description: >-
            Seconds until the current rate-limit window resets. Absent when the
            request was rejected by the gateway's global protection limit.
          schema:
            type: integer
            minimum: 0
    ServerError:
      content:
        application/json:
          examples:
            internal:
              value:
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Unexpected server-side error. Include the request_id when reporting.
  securitySchemes:
    AppKeyAuth:
      description: >-
        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.
      in: query
      name: app_key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.