Skip to main content
POST
/
subscriptions
/
{watchlistId}
curl --request POST \
  --url https://api.nevua.markets/subscriptions/{watchlistId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "Watchlist",
  "rule": {
    "type": "New or closed events and markets"
  },
  "channels": [
    {
      "type": "Webhook",
      "settings": {
        "webhookUrl": "https://your-webhook-endpoint.com/status-changes"
      }
    }
  ]
}
'
{
"subscriptionId": "507f191e810c19729de860ea"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

watchlistId
string
required

The ID of the watchlist to create a subscription for

Body

application/json
scope
enum<string>
required

The scope of the subscription. Currently only Watchlist is supported.

Available options:
Watchlist
rule
Event and Market Status Changes · object
required

A 'New or closed events and markets' rule will fire an alert when new events and markets are created or when existing ones close.

This rule is always Recurring and will fire as soon as a market/event status change is detected.

channels
object[]
required

The channels to send the alert to.

Response

Subscription created successfully

subscriptionId
string
required