About Webhooks

1 minute read

Webhooks are a powerful tool that can notify you of important events in ServiceChannel. With webhooks, you will be getting updates as they happen rather than constantly polling for the latest data.

Webhook cartoon

You can configure webhooks either through the API or UI. Setting up webhooks is pretty simple: 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 configured URL.

Important: To create and manage webhooks, you need to have either a subscriber account with the Super Admin role or provider account with admin rights.

Events

We can alert you each time an 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-in to 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 enable/disable flag — are common for all subscriptions within one webhook, while each subscription has its own settings: a list of events you want to subscribe to and event filters, also called event rules.

One subscription can contain events only related to the same object. For example, to receive notifications on 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 in SC.

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

Webhook limits