Skip to content
Vectis
Book a demo

For organisation administrators

Install partner applications, manage their scopes and webhooks, monitor their activity and uninstall them.

This guide is for administrators who install and manage partner applications for their organisation. Most tasks can be done in the Vectis web app; the Partner API operations that match each task are listed in the API reference.

Browse the Marketplace

Open the Marketplace from the puzzle icon in the top bar. You can:

  • browse all published applications;
  • filter by category;
  • search by name or description;
  • see featured applications;
  • open an application to see its description, partner, links, current version and changelog.

Install an application

You need the marketplace.install permission, which System Administrator users have.

  1. Open the application

    Find the application in the Marketplace and select Install on its detail page.

  2. Review

    Check the application and its developer.

  3. Choose permissions

    The wizard lists the API scopes the application asks for. Select the scopes you want to grant, or Select all. Sensitive scopes, such as users:read and organisation:read, are flagged and need explicit consent.

  4. Confirm

    Check how many scopes you are granting, then select Install Application.

  • The application must be published to be installed.
  • Each organisation can install an application only once.
  • A unique webhook secret is generated for the installation.
  • The partner application uses this installation's scopes to access your organisation's data.

Manage granted scopes

You need the marketplace.manage permission. Open Settings → Marketplace Apps, choose the application, and open the Scopes tab. From there you can grant a new scope or revoke one that is granted. A revoked scope can be granted again at any time, and changes take effect on the application's next API call.

Configure webhooks

Webhooks send event notifications from Vectis to the partner application, such as when a booking is created or a trip is completed. The full list is in the webhook topics reference.

The Webhooks tab of an installed application shows which topics it subscribes to and where events are sent. Through the Partner API, an administrator with marketplace.manage can:

  • subscribe the installation to a topic, with the endpoint URL to deliver to;
  • change a subscription's endpoint URL;
  • unsubscribe from a topic;
  • send a test event to check the endpoint is working;
  • rotate the installation's webhook signing secret, if it has been compromised or for periodic rotation;
  • view the delivery history of a subscription.

After rotating the webhook secret, the partner application must verify signatures with the new secret.

Each delivery has one of these statuses: Pending, Delivered, Failed or Dead lettered. Failed deliveries are retried automatically: immediately, after 1 minute and after 5 minutes. After 3 failed attempts the delivery is marked dead lettered.

Monitor installed apps

Settings → Marketplace Apps lists every application installed for your organisation, with its partner, version and granted scopes. Open one to see:

TabWhat it shows
OverviewThe installation's status and details.
ScopesThe scopes granted, who granted them and when.
WebhooksWebhook subscriptions and their endpoints.
Data SyncFor apps that import data, the sync status and last import.
ActivityThe API requests the application made: operation, scopes used, status, duration and time.

Uninstall an application

Uninstalling an application revokes all of its OAuth tokens, disables all of its webhook subscriptions and removes the installation. Data it imported earlier is kept.

  1. Open the installed app

    Go to Settings → Marketplace Apps and choose the application.

  2. Uninstall

    Select Uninstall, then Confirm Uninstall.