ServiceChannel API is organized around REST. It supports OAuth 2.0 for authorizing requests, accepts standard HTTP verbs, and returns JSON-formatted data. Using the ServiceChannel Developer Portal you can update to update work orders, process proposals, generating invoices, and more. 
Integration OverviewBefore navigating to the Development portal, you can find information about API integration in the Integration section of Provider Automation. The Integration section has the following subsections: toc - Overview
- App Registration
- Permissions
- WebHooks
Note |
---|
- To add the Integration section to your Provider Automation, contact your ServiceChannel representative.
- Once the Integration section becomes active, only users with the Provider Automation Admin user role can view and manage it.
|
Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Access the Integration Section |
---|
| - Log in to your ServiceChannel account.
- From the hamburger menu, select Administration > Integration.
[image] Image Added
|
Overview[image] Image Added This page provides information that you may need while working with the ServiceChannel API: - A link to the Development portal where you can learn API basics, read guides and news.
- A link to the API Reference page where you can access API methods in the production environment.
- A link to the Sandbox Mode page where you can learn how to experiment on API methods in the SB2 environment.
Tip |
---|
On the right side of the Overview page, you can find your ProviderID. |
App Registration[image]
Registering an Application Image Added
On this page, you can find a link to the App Registration page at the Development portal., you can alsoadd API client information. Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Add New Client |
---|
| - On the App Registration page, click the Add New ClientNew Client button.
- In the Add API Client InfoClient Info window, fill the necessary fields:
[image] Image Added
- Click Save.
|
PermissionsOn this page, you can download a contractor request form and viewwhich permissions subscribers have set for you. [image] Image Added Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Download the Form |
---|
| - On the Permissions page, click the Download Form button.
[image] Image Added
- Find the file in the Dfolder of your computer.
|
About Permissions Table Note |
---|
Expand |
---|
title | Click here to see a full list of permissions and their definitions |
---|
|
Permission | Description |
---|
Incoming XML
| Active | When turned on, it allows a subscriber to switch on any permissions for a certain provider. | Note Creation | Allows a provider user to create work order notes via XML. | ScheduleDateUpdate | Allows a provider user to change a scheduled date via XML. Info |
---|
This permission affects both XML and API requests. |
| WorkorderCreate | Allows a provider user to create work orders via XML. Info |
---|
This permission affects both XML and API requests. |
| NTEUpdate | Allows a provider user to change an NTE amount via XML. | StatusUpdate | Allows a provider user to changethework order status via XML. | Set status toCOMPLETED_PENDING | Allows a provider user to changethework order status to Completed Pendingvia XML. | Set statusto COMPLETED | Allows a provider user tochange the work order status to Completedvia XML. | IVRCheck IN/OUT | Allows a provider user to make check in/out via XML.
Info |
---|
This permission affects both XML and API requests. When this permission is disabled for a provider, they can make check in/out via API,but they cannot set the certain time of check in/out. |
| Allow to useMAIL_TO | Allows a provider user to add email recipients while creating a work order note. | Outgoing XML
| NewWO send | Notifies a provider via XML once a work order is created. | NewNote sent | Notifies a provider via XML once a work order note is created. | NewIVR sent | Notifies a provider via XML once a check in/out record is created. |
|
|
Tip |
---|
For your convenience, you can sort the Permissions table by the certain subscriber. [image] Image Added |
Managing WebHooks[image] Image Added Webhooks allow you to receive notifications of important events. You can create a subscription to events, such as work order creation, NTE change, proposal update, or invoice approval.After creating a webhook for a particular event, you will get notified once this event occurs. Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Create a WebHook in Provider Automation |
---|
| - On theWebhookspage, click the Add Webhook button.
[image] Image Added
- In the Name field, enter the webhook’s name.
- InActive.
In the URL field, enter the endpoint where you want to get notifications.
Tip |
---|
Click the Ping URL button, to send a test notification to your endpoint. |
- (Optional) In the Description field, enter ashort descriptionabout the webhook you are creating.
- Click the Add Subscription button.
[image] Image Added
- In Object Type, select the object of notifying, for example, a work order, a proposal, an invoice.
- In the Name field, enter a subscription name.
- (Optional)If you want to create a webhook for a certain trade, click the Add / Remove Trades button, on the popup window,select the necessary trade or trades, and click Ok.
- (Optional) If you want to create a webhook for a certain category, click the Add / Remove Categories button, and then on the popup window, select the necessary category or categories, and click Ok.
- (Optional) If you want to create a webhook for a certain status, the Add / Remove Statusesbutton, and thenon the popup window, select the necessary category or categories, and click Ok.
- Click the Add Subscription button.
[image]
- Select the event that you want to be notified about.
[image] Image Added
Click the Save Webhook button. The webhook is created. [image]
Image Added Repeat steps 1-5 to create another webhook. Tip |
---|
delete the webhook anytime. |
|
Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Update a Webhook in Provider Automation |
---|
| - On the WebHooks page, from the list of webhooks, click the necessary webhook.
[image] Image Added
- Edit the general webhook information:
- Name
- URL
- Description
[image] Image Added
- Add or remove the webhook events by selecting or deselecting them.
[image] Image Added
- manage statuses, categories, and trades, click the Edit button.
Image Added
- Add or remove them by clicking the Add / Remove Trades, the Add / Remove Categories, and/or the Add / Remove Statuses buttons.
Image Added
- Confirm the subscription changes by clicking the Update Subscription button.
- Confirm all changes by clicking the Save Webhook button.
|
RemovingIf you no longer need to use the webhook, you can remove it in two ways: Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Deactivate a WebHook in Provider Automation |
---|
| - On the WebHooks page, from the list of webhooks, click the webhook you want to deactivate.
Image Added
- Select Inactive.
Image Added The webhook’s status changes from Active to Inactive.
Image Added
|
Panel |
---|
bgColor | #F9F9F9 |
---|
titleColor | #0e3367 |
---|
titleBGColor | #EAEAEA |
---|
borderStyle | none |
---|
title | ⦿ How to Delete a WebHook in Provider Automation |
---|
| - On the WebHooks page, from the list of webhooks, click the webhook you want to delete.
Image Added
- Click the Delete Webhook button.
|
|