Topics

Retrieve a topic subscription

Retrieve a subscription by its unique identifier for a topic.

get/v2/topics/{topicKey}/subscriptions/{identifier}

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v2/topics/{topicKey}/subscriptions/{identifier}
  • Auth: API key in header Authorization

Path parameters

topicKeystring required

The key identifier of the topic

identifierstring required

The unique identifier of the subscription

Response

OK

Example response

{
  "data": {
    "id": "64f5e95d3d7946d80d0cb679",
    "identifier": "subscription-identifier",
    "name": "My Subscription",
    "preferences": [
      {
        "subscriptionId": "64f5e95d3d7946d80d0cb679",
        "workflow": {
          "id": "64a1b2c3d4e5f6g7h8i9j0k1",
          "identifier": "welcome-email",
          "name": "Welcome Email Workflow",
          "tags": [
            "user-onboarding",
            "email"
          ],
          "data": {
            "category": "onboarding",
            "priority": "high"
          }
        },
        "enabled": true,
        "condition": {
          "and": [
            {
              "===": [
                {
                  "var": "payload.tier"
                },
                "premium"
              ]
            }
          ]
        }
      }
    ],
    "contextKeys": [
      "tenant:org-a",
      "project:proj-123"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.