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
- Base URLhttps://sb2api.servicechannel.com/v3
- AuthOAuth 2Authorization codehttps://sb2login.servicechannel.com/oauth/authorizeToken URLhttps://sb2login.servicechannel.com/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
The webhook is created.
Changes
No recorded changes to this operation across all 1 revision of this API.