NotificationSubscriptions

Update a subscription

Updates the specified subscription by setting the values of the parameters passed. <br />Example Request

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

Request

Path parameters

idinteger required

The unique ID of the subscription to update.

Request body

Idinteger

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

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 updated, and the response is intentionally blank.

Changes

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