Alert Streaming Configuration

Deprecated

Deprecated: This API will be deprecated and no longer supported starting June 2025.

Manages on-demand Streaming Configuration.

Notes

User with roles with below permissions are permitted to use the APIs

  • The User who creates Streaming Configuration.
  • Partner Admin user who has all managed permissions.
  • Partner user who has administration permission
  • Service Provider user.

Note: To use this API, you must enable the Stream Exports Add-on and have the REPORTS_MANAGE and INTEGRATION_VIEW permissions assigned.

Get the streaming configurations.

Path Parameters

  • partnerIdstringrequired

    Describes the unique identifier of the provider (mspId)

Query Parameters

  • namestring

    Streaming name

Responses

  • resultsarray

  • totalResultsinteger

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • descendingOrderboolean

    Response Samples

    {
  "results": [
    {
      "id": "streamexp-6f3a09ce-12fc-404a-922a-bdc2890fa71b",
      "name": "alert streaming",
      "allClients": false,
      "categoryType": "Alerts",
      "rawEvents": false,
      "exportIntegration": {
        "id": "INTG-8528ea12-14af-4065-9cae-a6ac19e4beaa",
        "name": "streamExport"
      },
      "clients": [
        {
          "id": "client_13",
          "name": "Job Testing"
        },
        {
          "id": "client_11",
          "name": "Ops Lab"
        }
      ]
    }
  ],
  "totalResults": 1,
  "pageNo": 1,
  "pageSize": 100,
  "totalPages": 1,
  "nextPage": false,
  "descendingOrder": false
}

    Note: To use this API, you must enable the Stream Exports Add-on. You also need to have the REPORTS_MANAGE and INTEGRATION_MANAGE permissions assigned.

    Create streaming configurations.

    Path Parameters

    • partnerIdstringrequired

      Describes the unique identifier of the provider (mspId)

    Request Body

    application/json

    Request Body Samples

    {
  "name": "alert webhook stream",
  "clients": [
    "client_12",
    "client_28",
    "37be2441-1636-4756-93da-5cb1d95da2b6fh8ei9"
  ],
  "categoryType": "Alerts",
  "exportIntegration": "INTG-37be2441-1636-4756-93da-5cb1d95da2b6",
  "rawEvents": false
}

    Responses

    • idstring

    • namestring

    Response Samples

    {
  "id": "streamexp-2e84f4fb-d1bc-435f-8c1e-62690989e17c",
  "name": "alert-webhook-stream"
}