Service Provider Pro

The Service Provider Pro modules 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 module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

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

1. Log in to your Service Provider Pro account.

2. Click Modules > API > Settings.

61f279654f0fe.png

3. Copy the API Key to your clipboard.

61f27966b271e.png

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

5. Click Add next to the Connection field.

61f2796825246.gif

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

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

The connection has been established.

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.

User 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 Make should return during one execution cycle. 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.

See the section, Setting Up Service Provide Pro Webhooks to add webhooks in your Service Provider account.

Watch Orders

Triggers when a new order is created or order status changed or order is tagged.

Webhook

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.

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

61f2796a94681.png

Matches of the search can be found in the module's Output under Bundle > Body. In our example, 9 orders were returned:

61f2796bb9fbf.png

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 trigger.

61f2796d0d19d.gif

2. Log in to your Service Provider Pro account.

3. Click the Modules > Webhooks Settings.

Image 859130

4. Click the Add endpoint button.

61f27971444d9.png

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 token

This field is auto-generated by the system.

61f27972a4f9d.png

The webhook is successfully added.