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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Unsubscribe

List Subscriptions

Required Permissions#

Request

Request samples

Responses

Required Permissions