NotificationWebHooks

Create a webhook

Creates a new webhook for the specified event types. Returns a unique webhook ID for a successful request. See Event Objects for example notification objects and descriptions of their fields. <br />Note: You can create webhooks using API or via the Service Automation Admin. <br />Example Request

            POST /NotificationWebHooks
            {
              "Subscriptions": [
                {
                  "Name": "Subscription to new WOs",
                  "EventTypes": [
                    "WorkOrderCreated"
                  ],
                  "Rules": {
                    "Trades": [
                      "GLASS"
                    ],
                    "Categories": [
                      "MAINTENANCE"
                    ],
                    "Statuses": [
                      "COMPLETED/CONFIRMED"
                    ]
                  }
                }
              ],
              "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"
            }
post/NotificationWebHooks

Request

Request body

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 created.

Idinteger

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

SubscriptionsResponsesinteger[]

Changes

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