Skip to main content

Quick Actions

The Quick Actions API enables you to embed external tools directly into your Shared Spaces. By incorporating calendar scheduling, document signing, or other integrations, you can streamline collaboration and enhance productivity for your revenue teams.

Quick Actions in Shared Spaces

What you'll learn

  • How to create and configure Quick Actions in Shared Spaces
  • How to list and retrieve Quick Action details
  • How to update and delete Quick Actions
  • How to work with Shared Space extensions
TL;DR

When to use the API

Calendar
Integration
Document
Signing
Custom
Workflows
Dynamic
Actions
Embed scheduling tools like Calendly, HubSpot, or Cal.com directly in Shared Spaces.Add e-signature buttons for contracts and agreements.Create action buttons that link to external business tools.Programmatically add or remove actions based on deal stage.
Prerequisites

Quick Actions terminology

Before working with Quick Actions, familiarize yourself with these key terms:

TermDescription
Quick ActionAn action button displayed in a Shared Space that links to an external tool via an iFrame. Each Quick Action is powered by a Shared Space Extension.
Shared Space ExtensionA component defined in a Showpad App that enables Quick Actions. Extensions specify valid domains that can be embedded.
sharedSpaceExtensionIdThe unique identifier of the extension that powers a Quick Action. Required when creating a Quick Action.
isInternalBoolean flag that determines visibility. When true, only internal users (sellers) can see the Quick Action. When false, both internal and external users (buyers) can see it.
validDomainsURLs configured in the extension that permit embedding within an iFrame. The Quick Action URL must match one of these domains.

Base endpoint

Every request uses the API v4 base endpoint:

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

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

Shared Spaces

Before creating Quick Actions, you need to identify the Shared Space and the installed extensions.

List Shared Spaces

Retrieve all Shared Spaces in your organization:

MethodEndpointDescription
GET/shared-spacesReturns a list of all Shared Spaces in your organization.

Example Request

curl "https://{{subdomain}}.api.showpad.com/v4/shared-spaces?participantEmail=bob.smith%40showpad.com&limit=100" \
-H "Authorization: Bearer {access_token}"

Example Response

{
"count": 1,
"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"
}
]
}

List of Shared Space Extensions

Different Base Endpoint

This request uses the Apps API base endpoint (/apps/v1), not the standard v4 endpoint.

Retrieve a list of all installed Shared Space extensions:

MethodEndpointDescription
GET/apps/v1/shared-space-extensionsReturns all Shared Space extensions installed in your organization.

Example Request

curl "https://{{subdomain}}.api.showpad.com/apps/v1/shared-space-extensions" \
-H "Authorization: Bearer {access_token}"

Example 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 Action

Add a new Quick Action to a Shared Space:

MethodEndpointDescription
POST/shared-spaces/{id}/quick-actionsCreates a Quick Action in a Shared Space.

Example Request

curl -X POST "https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{sharedSpaceId}/quick-actions" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{
"title": "Schedule Meeting",
"url": "https://calendly.com/your-link",
"sharedSpaceExtensionId": "extension-id",
"isInternal": false
}'

Example Response

{
"id": "QuickActionId",
"title": "Schedule Meeting",
"url": "https://calendly.com/your-link",
"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

Retrieve all Quick Actions in a Shared Space:

MethodEndpointDescription
GET/shared-spaces/{id}/quick-actionsReturns all Quick Actions in a Shared Space.

Example Request

curl "https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{sharedSpaceId}/quick-actions" \
-H "Authorization: Bearer {access_token}"

Example Response

{
"count": 1,
"items": [
{
"id": "QuickActionId",
"title": "Schedule Meeting",
"url": "https://calendly.com/your-link",
"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

Retrieve a specific Quick Action:

MethodEndpointDescription
GET/shared-spaces/{id}/quick-actions/{quickActionId}Returns the specified Quick Action.

Example Request

curl "https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{sharedSpaceId}/quick-actions/{quickActionId}" \
-H "Authorization: Bearer {access_token}"

Example Response

{
"id": "QuickActionId",
"title": "Schedule Meeting",
"url": "https://calendly.com/your-link",
"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

Update a Quick Action's properties:

MethodEndpointDescription
PATCH/shared-spaces/{id}/quick-actions/{quickActionId}Modifies the specified Quick Action.

Example Request

curl -X PATCH "https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{sharedSpaceId}/quick-actions/{quickActionId}" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{"title": "Book a Demo Call"}'

Example Response

{
"id": "QuickActionId",
"title": "Book a Demo Call",
"url": "https://calendly.com/your-link",
"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

Permanently remove a Quick Action:

MethodEndpointDescription
DELETE/shared-spaces/{id}/quick-actions/{quickActionId}Permanently removes the Quick Action.

Example Request

curl -X DELETE "https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{sharedSpaceId}/quick-actions/{quickActionId}" \
-H "Authorization: Bearer {access_token}"

Example Response

HTTP Status 204 No Content

Next steps

Now that you understand how to work with Quick Actions, explore these related topics:

Was this page helpful?