ROCKITPLAY API
  1. Subscriptions
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Minimal Tests
      • ping
      • submit test task
    • Admin Edge Organizations
      • Create Organization
      • Delete Organization
  • ROCKIT Edge - Backend API
    • Backend Edge Organizations
      • Create Organization
      • Delete Organization
    • Authentication
      • user login
      • authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
    • Deployments
      • Creating Deployments
      • Get Deployments
      • Get Deployment Details
      • Modify Deployment
      • Deleting Deployments
    • Apps
      • Creating Apps
      • Import native builds
      • App Details
      • List Apps
      • patch app
      • Delete Apps
    • Triggers
      • Process Traces
      • Retry Task
    • Tasks
      • Listing Tasks
      • Task Details
      • Acknowledge Warning / Expire Task
    • Subscriptions
      • Subscribe
        POST
      • List Subscriptions
        GET
      • Unsubscribe
        DELETE
    • Roles
      • List Roles
      • Create Role
      • Patch Role
      • Role Details
      • Delete Roles
  • Changelog
    • Changelog
  1. Subscriptions

List Subscriptions

GET
https://Example-Server.com/be/v1/subscriptions
Last modified:2025-05-08 12:00:04
This endpoint can be used to list all the Organization's subscriptions of events on the ROCKIT Edge.

Required Permissions#

subscriptions.read
See Roles for more details.

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://Example-Server.com/be/v1/subscriptions?offset=0&limit=1&order[]=[-name]' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "subscriptions": [
        {
            "event": "end",
            "orgName": "someOrg",
            "type": "slack",
            "sender": "deploy",
            "name": "deploySlack",
            "slack": {
                "channelId": "#rockitplay-events"
            }
        },
        {
            "event": "error",
            "orgName": "someOrg",
            "type": "webhook",
            "sender": "dltar",
            "name": "dltarWebhook",
            "webhook": {
                "url": "http://example.com/webhook"
            }
        },
        {
            "orgName": "someOrg",
            "event": "exception",
            "sender": "dltar",
            "type": "webhook",
            "name": "dltarWebhook",
            "webhook": {
                "url": "http://example.com/webhook"
            }
        },
        {
            "orgName": "someOrg",
            "sender": "deploy",
            "event": "end",
            "type": "webhook",
            "name": "deployWebhook",
            "webhook": {
                "url": "http://example.com/webhook"
            }
        },
        {
            "orgName": "densowOrg",
            "sender": "deploy",
            "event": "error",
            "type": "webhook",
            "name": "deployWebhook",
            "webhook": {
                "url": "http://example.com/webhook"
            }
        }
    ],
    "totalCount": 5
}
🟠400Invalid Param
🟠401Unauthorized
Modified at 2025-05-08 12:00:04
Previous
Subscribe
Next
Unsubscribe
Built with