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
offset
integer 
optional
Pagination offset.
Example:
0
limit
integer 
optional
Pagination limit.
Default:
10
Example:
1
order[]
array[string]
optional
Sorting order. Supported fields for sorting: "name". +/- for Ascending/Descending (no +/- results in ascending order)
Example:
["[-name]"]
Header Params
x-rockit-beauth-token
string 
optional
ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.
Example:
{{_edge_org_admin_beauth_token}}
x-rockit-orgname
string 
optional
Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.
Example:
{{EDGE_ORG_NAME}}
x-rockit-username
string 
optional
Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.
Example:
adminPrincipal
x-rockit-api-key
string 
optional
Unique and imuutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.
Example:
{{_adminPrincipal_apiKey}}

Request 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
status
string 
required
A string confirming that the retrieval of subscriptions was successful.
subscriptions
array [object {7}] 
required
An array of subscription objects that provides details about each subscription (such as the event type, sender, notification type, and receiver information like webhook URL or Slack channel).
event
string 
required
orgName
string 
required
type
string 
required
sender
string 
required
name
string 
required
slack
object 
optional
webhook
object 
required
totalCount
integer 
required
An integer representing the total number of subscriptions returned by the query.
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
Previous
Subscribe
Next
Unsubscribe
Built with