This documentation covers Fullstory’s system webhooks and v1 APIs. For streaming webhooks, please refer to v2.

This feature is paid only. To view available plans, please see this page.

List Event Subcategories

For event types that have subcategories, this pages through the available subcategories. A subcategory definition may include an optional displayName property. If so, user agents that show the results as a list should show that value to users instead of the subcategory value.

Path Parameters

event_name string required

The name of an event type that has subcategories, as returned by the List Event Types API.

Query Parameters

pagination_token string optional

Optional pagination token, for retrieving further results after a previous page request.

limit int32 optional

Optional limit to the number of values returned. If not specified, the max (1000) values are returned.

Responses

200

---

A successful response.

Schema

Example

---

Schema

subcategory_defs object[] optional
The list of subcategory definitions, up to the requested limit.
Array [
subcategory string optional
The subcategory value. This is the value used when configuring endpoints that receive event messages for this subcategory.
display_name string optional
A user-friendly display name for the subcategory. If empty, user agents should show the subcategory value.
]
next_pagination_token string optional

If present, this pagination token can be supplied in a subsequent request to get the next batch of results. If not present, there are no further results.

{
  "subcategoryDefs": [
    {
      "subcategory": "QWRkZWQgSXRlbSB0byBDYXJ0QWRkZWQgSXRlbSB0byBDYXJ0QWRkZWQgSXRlbSB0byBDYXJ0QWRkZWQgSXRlbSB0byBDYXJ0",
      "display_name": "Added Item to Cart"
    },
    {
      "subcategory": "U2F3IEVycm9yIFBvcHVwU2F3IEVycm9yIFBvcHVwU2F3IEVycm9yIFBvcHVwU2F3IEVycm9yIFBvcHVw",
      "display_name": "Saw Error Popup"
    },
    {
      "subcategory": "VHJhbnNhY3Rpb24gQ29tcGxldGU=VHJhbnNhY3Rpb24gQ29tcGxldGU=VHJhbnNhY3Rpb24gQ29tcGxldGU=VHJhbnNhY3Rpb24gQ29tcGxldGU=",
      "display_name": "Transaction Complete"
    }
  ]
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Loading...