Quick Actions

Shared Space Quick Actions enable you to easily embed external tools into your Shared Spaces. By incorporating calendar scheduling within Shared Spaces, you can streamline collaboration efforts and enhance productivity for your revenue teams.

Prerequisites

• Showpad Ultimate package
• Showpad admin account
• Shared Spaces enabled
• An installed Showpad App with a Shared Space Extension

Base Endpoint

The base endpoint for quick actions calls is:

https://{{subdomain}}.api.showpad.com/v4

Every API v4 request needs to be prefixed with the base endpoint.

Once your Showpad App with one or more Shared Space extensions is installed, you can make the following API calls.

Shared Spaces

List of Shared Spaces

You can retreive a list of all Shared Spaces with the following request:

Method	Endpoint	Description
GET	/shared-spaces	Returns a list of all of the Shared Space extensions in your organization.

Example

curl -X 'GET' \
  'https://{{subdomain}}.api.showpad.com/v4/shared-spaces?participantEmail=bob.smith%40showpad.com&offset=0&limit=1000' \
  -H 'accept: application/json'

Response

200: Request is successful

{
  "count": 0,
  "items": [
    {
      "id": "{{shared space ID}}",
      "title": "Sales and Marketing teams",
      "status": "ACTIVE",
      "createdAt": "2019-08-24T14:15:22.000Z",
      "lastActivityAt": "2019-08-24T14:15:22.000Z",
      "archivedAt": "2019-08-24T14:15:22.000Z"
    }
  ]
}

List of Shared Space Extensions

Caution

This request uses a different base endpoint.

You can retrieve a list of all installed Shared Space extensions with the following request:

Method	Endpoint	Description
GET	https://{{subdomain}}.api.showpad.com/apps/v1/shared-space-extensions	Returns a list of all of the Shared Space extensions installed in your organization.

Example

curl --location 'https://{{subdomain}}.api.showpad.com/apps/v1/shared-space-extensions' \
--header 'authorization: Bearer {{API token}}'

Response

{
    "items": [
        {
            "id": "SharedSpaceExtensionId",
            "appId": "appId",
            "versionId": "versionId",
            "name": "Shared Space Calendar Extension",
            "extensionKey": "shared-spaces-calendar-extensions",
            "description": "My Shared Space Calendar Extension",
            "icon": "https://some-png-icon.png",
            "injectShowpadJs": true
        }
    ],
    "itemsCount": 1
}

Quick Actions

Create Quick Actions

You can add a new Quick Action with the following request:

Method	Endpoint	Description
POST	/shared-spaces/{shareId}/quick-actions	Creates a quick action in a shared space.

Example

curl --location --request POST 'https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{shared space ID}/quick-actions' \
--header 'authorization: Bearer {{API token}}' \
--header 'content-type: application/json' \
--data '{"title":"Quick Actions","url":"https://calendar-apps.com","sharedSpaceExtensionId":"SharedSpaceExtensionId","isInternal":false}'

Response

{
    "id": "QuickActionId",
    "title": "Quick Actions",
    "url": "https://calendar-apps.com",
    "isInternal": false,
    "sharedSpaceExtension": {
        "id": "SharedSpaceExtensionId",
        "name": "Shared Space Calendar Extension",
        "description": "My Shared Space Calendar Extension",
        "icon": "https://some-png-icon.png"
    }
}

List of Quick Actions

You can retrieve a list of all Quick Actions in a Shared Space with the following request:

Method	Endpoint	Description
GET	/shared-spaces/{shared space ID}/quick-actions	Returns a list of all of the Quick Actions available in a shared space.

Example

curl 'https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{shared space ID}/quick-actions' \
  -H 'authorization: Bearer {{API token}}'

Response

{
    "count": 1,
    "items": [
        {
            "id": "QuickActionId",
            "title": "Quick Actions",
            "url": "https://some-png-icon.png",
            "isInternal": false,
            "sharedSpaceExtension": {
                "id": "SharedSpaceExtensionId",
                "name": "Shared Space Calendar Extension",
                "description": "My Shared Space Calendar Extension",
                "icon": "https://some-png-icon.png"
            }
        }
    ]
}

Get Quick Action by ID

You can retreive a specific Quick Action with the following request:

Method	Endpoint	Description
GET	/shared-spaces/{shared space ID}/quick-actions/{quick-action}	Returns the Quick Action for the specified identifier in a shared space.

Example

curl 'https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{shared space ID}/quick-actions/{quickActionId}' \
  -H 'authorization: Bearer {{API token}}'

Response

{
    "id": "QuickActionId",
    "title": "Quick Actions",
    "url": "https://some-png-icon.png",
    "isInternal": false,
    "sharedSpaceExtension": {
        "id": "SharedSpaceExtensionId",
        "name": "Shared Space Calendar Extension",
        "description": "My Shared Space Calendar Extension",
        "icon": "https://some-png-icon.png"
    }
}

Update Quick Action

You can update a specific Quick Action with the following request:

Method	Endpoint	Description
PATCH	/shared-spaces/{shared space ID}/quick-actions/{quick-action}	Modifies the Quick Action for the specified identifier.

Example

curl --location --request PATCH 'https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{shared space ID}/quick-actions/{quickActionId}' \
  -H 'authorization: Bearer {{API token}}' \
  -H 'content-type: application/json' \
  --data '{"title":"New Name"}'

Response

{
    "id": "QuickActionId",
    "title": "New Name",
    "url": "https://some-png-icon.png",
    "isInternal": false,
    "sharedSpaceExtension": {
        "id": "SharedSpaceExtensionId",
        "name": "Shared Space Calendar Extension",
        "description": "My Shared Space Calendar Extension",
        "icon": "https://some-png-icon.png"
    }
}

Delete Quick Action

You can delete a specific Quick Action with the following request:

Method	Endpoint	Description
DELETE	/shared-spaces/{shared space ID}/quick-actions/{quick-action}	Permanently removes the Quick Action with the specified identifier.

Example

curl --location --request DELETE 'https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{shareId}/quick-actions/{quickActionId}' \
  -H 'authorization: Bearer {{API token}}'

Response

Shared Space Quick Action was successfully deleted