NotificationWebHooks

Update a webhook

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

            PUT /NotificationWebHooks/{id}
            {
              "Subscriptions": [
                {
                  "Id": 1111,
                  "Name": "Subscription to new WOs",
                  "EventTypes": [
                    "WorkOrderCreated"
                  ],
                  "Rules": {
                    "Trades": [
                      "GLASS"
                    ],
                    "Categories": [
                      "MAINTENANCE"
                    ],
                    "Statuses": [
                      "COMPLETED/CONFIRMED"
                    ]
                  }
                }
              ],
              "Id": 1,
              "Enabled": true,
              "Name": "New WO webhook",
              "Description": "I want to receive notifications when new WOs of GLASS trade and MAINTENANCE category are created.",
              "Url": "https://your-company.com/webhook-target-URL"
            }
put/NotificationWebHooks/{id}

Request

Path parameters

idinteger required

The unique ID of the webhook to update.

Request body

Idinteger

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

ResetOptionsboolean
Enabledboolean

Defines if the webhook is active or inactive.

Namestring required

The user-friendly name for the webhook.

Descriptionstring

The description of the webhook.

Urlstring required

The URL to which the events should be delivered.

Response

The webhook is updated, and the response is intentionally blank.

Changes

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