NotificationSubscriptions

Create a subscription

Creates a new subscription to the specified event types. Returns a unique subscription ID for a successful request. See Event Objects for example notification objects and descriptions of their fields. <br />Example Request

            POST /NotificationSubscriptions/Http
            {
              "Url": "https://your-company.com/webhook-target-URL",
              "Enabled": true,
              "Name": "Subscription to new WOs",
              "EventTypes": [
                "WorkOrderCreated"
              ],
              "Rules": {
                "Trades": [
                  "GLASS"
                ],
                "Categories": [
                  "MAINTENANCE"
                ]
              }
            }
post/NotificationSubscriptions/Http

Request

Request body

Urlstring required

The URL to which the events should be delivered.

Enabledboolean

Defines if the subscription is active or inactive.

Namestring required

The user-friendly name for the subscription.

EventTypesstring[] required

The list of events to subscribe to. Events within one subscription should belong to one object.

Response

The subscription is created.

Idinteger

The unique subscription ID. Generated automatically and cannot be modified.

Changes

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