@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

next
md 56 lines 4.19 KB
Rendered Raw
1 ## How do I set up custom OAuth credentials for ServiceM8?
2
3 Composio-managed OAuth works for ServiceM8 without any setup. Use your own ServiceM8 add-on when you want your app name on the consent screen and control over its permissions. You need a [ServiceM8 developer account](https://developer.servicem8.com/).
4
5 ### Create the ServiceM8 add-on
6
7 1. Sign in to ServiceM8 and open **Developer** from the main menu. On **Store Items**, click **Add Item**.
8
9 ![ServiceM8 Store Items page with the Add Item button](/images/toolkits/servicem8/store-items.webp)
10
11 2. Enter a **Name** and **Description**. Keep **Category** set to **Add-on**, choose a price (Free works for a private integration), and click **Save**. ServiceM8 opens the add-on's settings.
12
13 ![ServiceM8 New Store Item form with name, Add-on category, description and Free price](/images/toolkits/servicem8/new-store-item.webp)
14
15 3. Scroll to **Addon OAuth Credentials** and copy the **App Id** and **App Secret**. These are the client ID and client secret in Composio.
16
17 ![ServiceM8 add-on settings showing Addon OAuth Credentials and Addon Type set to External Integration](/images/toolkits/servicem8/oauth-credentials.webp)
18
19 4. Under **Addon SDK**, set **Addon Type** to **External Integration**.
20 5. Set **Addon Activation URL** to `https://backend.composio.dev/api/v1/auth-apps/add` and click **Save**. ServiceM8 checks the OAuth redirect host against this URL, so it must match the auth config's `oauth_redirect_uri` field. See ServiceM8's [authentication docs](https://developer.servicem8.com/docs/authentication).
21
22 ![ServiceM8 Addon SDK settings with the Composio Addon Activation URL and Save button](/images/toolkits/servicem8/activation-url.webp)
23
24 ### Create the auth config in Composio
25
26 1. In the [Composio dashboard](https://dashboard.composio.dev/~/project/auth-configs?utm_source=docs&utm_medium=content&utm_campaign=toolkits-servicem8), go to **Auth Configs** → **Create** and select **ServiceM8**.
27
28 ![Composio Auth Configs page with the Create button](/images/toolkits/servicem8/auth-configs-create.webp)
29
30 ![Composio Create Auth Config dialog with ServiceM8 in the search results](/images/toolkits/servicem8/search-servicem8.webp)
31
32 2. Choose **OAuth 2.0** and **Your Own Credentials**. Enter the App Id as the client ID and the App Secret as the client secret. Keep the default redirect URI.
33
34 ![ServiceM8 auth config form with OAuth 2.0 and Your Own Credentials selected](/images/toolkits/servicem8/own-credentials.webp)
35
36 3. Under **Scopes**, choose the permissions your tools need, then click **Create Auth Config**.
37
38 ![Saved ServiceM8 auth config with custom credentials, the Composio redirect URI and the read_jobs scope](/images/toolkits/servicem8/auth-config-settings.webp)
39
40 4. Click **Connect Account** and sign in to the ServiceM8 account you want to connect. A new draft add-on shows **This Addon isn't verified**; confirm it's your add-on and click **Proceed**. Check the app name and permissions, then click **Allow**.
41
42 ![ServiceM8 This Addon isn't verified warning with the Proceed button](/images/toolkits/servicem8/unverified-warning.webp)
43
44 ![ServiceM8 consent screen requesting read-only access to jobs with the Allow button](/images/toolkits/servicem8/consent-screen.webp)
45
46 5. Open the auth config's **Accounts** tab and confirm the account shows **Active**. The auth config's own **Enabled** label doesn't mean an account is connected.
47
48 ![Composio auth config Accounts tab with a ServiceM8 connected account showing Active](/images/toolkits/servicem8/active-account.webp)
49
50 See [custom auth configs](/docs/auth-configuration/custom-auth-configs) for the general flow.
51
52 ### Scopes
53
54 ServiceM8 permissions are per resource, such as `read_jobs`, `manage_jobs`, `read_customers`, `manage_customers`, `read_staff`, and `read_schedule`. The default auth config requests read and manage permissions across jobs, customers, staff, schedule, inventory, assets, and messaging. A read-only jobs integration needs only `read_jobs`. See ServiceM8's [scope descriptions](https://developer.servicem8.com/docs/authentication).
55
56 The add-on can stay a draft. Publishing it to the ServiceM8 directory is a separate process, and submitting the add-on for review removes the unverified warning.