About Webhooks

Webhooks are a powerful tool that can notify you of important events happening to your work orders, invoices, or proposals. With webhooks, you will be getting updates as they happen rather than constantly polling for the latest data.

You can configure webhooks either through the ServiceChannel API or the Service Automation or Provider Automation UI. To set up webhooks, tell us the target URL for sending notifications, and specify the events to which you want to subscribe. When one of those events happens, we will deliver a notification to the indicated URL.

Important: To create and manage webhooks, you need to have the following permissions:

• For subscribers: an account with the Super Admin secondary role.
• For providers: an account with the Provider Automation Admin access level.

Events

We can alert you each time a ServiceChannel event happens, such as when a subscriber creates a work order, a technician checks in or out, a provider accepts a private network invitation, and more. You can subscribe to one particular event or opt for all events. For the full list of events that we support, see Types of Events.

Subscriptions

In ServiceChannel, each webhook consists of one or several subscriptions. Each subscription contains only same-object events.

Webhook settings — target URL and webhook status, either enabled or disabled — are common for all subscriptions within one webhook, while each subscription has its own settings: a list of events that you want to subscribe to and filters, also called event rules.

One subscription can contain events only related to the same object. For example, to receive notifications regarding both work orders and invoices, you should create either two subscriptions within one webhook or two separate webhooks.

Tip: Think of a webhook as a container for multiple subscriptions. Add one subscription per object.

Limits

There are limits to the number of webhooks you can set up.

You can create up to 20 webhooks and up to 20 subscriptions within each webhook. That means you can have up to 400 subscriptions.