Create a Event Subscription

post

https://{server}/ns-api/v2/subscriptions

Body Params

model

string

enum

This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model. Addtional details available in guide at https:///docs/event-subscriptions-1

post-url

url

This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production.

subscription-geo-support

string

enum

Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:

reseller

string

This is the reseller that the subscription will filter data for. * will be used for all resellersm, but only valid with Super User scope on the request.

domain

string

Defaults to *

This is the domain that the subscription will filter data for. * will be used for all domains, but only valid with Super User scope or Reseller scope if reseller is not * on the request.

user

string

Defaults to *

This is the user that the subscription will filter data for. * will be used for all users.

preferred-server

string

This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability.

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Authentication Required

404Record not found