Table of Contents

Service Provider Pro

Active with remarks
This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…)..

Service Provider Pro

The Service Provider Pro modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. allow you to monitor, create, list, and delete the order messages, orders, forms, accounts, invoices, messages, subscriptions, and tickets from your Service Provider Pro account.

Getting Started with Service Provider Pro

Prerequisites

A Service Provider Pro account – create an account at spp.co.

Note

The modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. dialog fields that are displayed in bold (in the Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory!

Connecting Service Provider Pro to Boost.space Integrator

To connect your Service Provider Pro account to Boost.space Integrator you need to obtain the API Key from your Service Provider Pro account and insert it in the Create a connection dialog in the Boost.space Integrator module.

1. Log in to your Service Provider Pro account.

2. Click Modules > API > Settings.

3. Copy the API Key to your clipboard.

4. Log in to your Boost.space Integrator account, add a module from the Service Provider Pro app into an Boost.space Integrator scenario.

5. Click Add next to the Connection field.

6. In the Connection name field, enter a name for the connection.

7. In the API Key and Subdomain namefield, enter the details copied in step 3, and click Continue.

The connection has been established.

Messages

Create an Order Message

Creates an order message.

Connection	Establish a connection to your Service Provider Pro account.
Order ID	Select or map the Order ID for which you want to create an order message.
Message	Enter (map) the message text.
UserCan use the system on a limited basis based on the rights assigned by the admin. ID	Enter (map) the User ID that is sending the message.
Staff Only	Select whether the message is accessible only to the staff.

List Order Messages

Lists all order messages.

Connection	Establish a connection to your Service Provider Pro account.
Order ID	Select or map the Order ID to list the order messages.
Limit	Set the maximum number of results Boost.space Integrator should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. The default value is 10.

Delete an Order Message

Deletes an order message.

Connection	Establish a connection to your Service Provider Pro account.
Order ID	Select or map the Order ID whose messages you want to delete.
Message ID	Select or map the Message ID you want to delete.

Webhooks

See the section, Setting Up Service Provide Pro Webhooks to add webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. in your Service Provider account.

Watch Orders

TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when a new order is created or order statusIn Boost.space, statuses are indicators assigned to records within modules to represent their current state or progress. They can be system-defined, such as "Active" or "Done," or custom-created to fit specific workflows. Statuses help track and manage tasks, projects, and processes efficiently. changed or order is tagged.

WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers.	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Watch Forms

Triggers when a form is submitted.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Watch Accounts

Triggers when an account is created or deleted.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Watch Invoices

Triggers when an invoice is created or paid or refunded.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Watch Messages

Triggers when a message is posted.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Watch Subscriptions

Triggers when a subscription is paid or failed or canceled.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Watch Tickets

Triggers when a ticket is created.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Service Provider Pro account.

Other

Make an API Call

Performs an arbitrary authorized API Call.

Connection

Establish a connection to your Service Provider Pro account.

URL

Enter a path relative to https://<domain>.spp.io/api For example: /v1/orders.

	Note
	For the list of available endpoints, refer to the Service Provider Pro API Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use – List Orders

The following API call returns all the orders from your Service Provide Pro account:

URL: /v1/orders

Method: GET

Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body. In our example, 9 orders were returned:

Setting Up Service Provider Pro Webhooks

1. Open any Watch module, enter a name for the webhook, click Save, and copy the URL address to your clipboard. Click OK and save the triggerThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario..

2. Log in to your Service Provider Pro account.

3. Click the Modules> Webhooks Settings.

4. Click the Add endpoint button.

5. Enter the following details and click Add endpoint.

URL to be called	Enter (map) the URL address copied in step 1.
Event to send	Select or map the event you want to watch.
Webhook tokenA secure code used to authenticate and authorize access to API endpoints, enabling users to connect with third-party applications.	This field is auto-generated by the system.

The webhook is successfully added.