API product catalogDeveloper Platform, Sandbox & Key Management

Get notification policy

Developer Platform, Sandbox & Key Management

GET

/notification-rules

Production onlygetNotificationRules

Returns notification rules plus the supported event and delivery-channel catalogues.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

rulesobject[]Required

rules[].idstring

rules[].enabledbooleanRequired

rules[].channelsstring[]Required

rules[].recipientsstring[]Required

rules[].severityall | critical | high

rules[].thresholdnumber | null

rules[].quietHoursstring | null

updatedAtstring | null

updatedBystring | null

availableEventsstring[]Required

availableChannelsstring[]Required

Response codes

200Current notification policy.

Request reference

Production only

Use the API Reference for this production-only or streaming operation.

https://mystocks.africa/api/v1/partner/notification-rules

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "rules",
    "availableEvents",
    "availableChannels"
  ],
  "properties": {
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "event",
          "enabled",
          "channels",
          "recipients"
        ],
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 120
          },
          "event": {
            "type": "string",
            "enum": [
              "float.low",
              "reconciliation.exception",
              "webhook.failed",
              "incident.opened",
              "approval.requested",
              "kyc.review",
              "usage.threshold",
              "certification.updated"
            ]
          },
          "enabled": {
            "type": "boolean",
            "default": true
          },
          "channels": {
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
              "type": "string",
              "enum": [
                "email",
                "webhook",
                "sms"
              ]
            }
          },
          "recipients": {
            "type": "array",
            "minItems": 1,
            "maxItems": 20,
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          },
          "severity": {
            "type": "string",
            "enum": [
              "all",
              "critical",
              "high"
            ],
            "default": "all"
          },
          "threshold": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0
          },
          "quietHours": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 80
          }
        }
      }
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "updatedBy": {
      "type": [
        "string",
        "null"
      ]
    },
    "availableEvents": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "availableChannels": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "email",
          "webhook",
          "sms"
        ]
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/v1/partner/notification-rules' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY"

POST /me

PUT /notification-rules