Zapier

Note

This integration is a premium integration. To activate the integration, you must follow a typical software development life cycle, which will incur additional costs. For more details on this integration or on other premium integrations, please contact your Brightspot representative.

Note

The topics in this section pertain only to Brightspot v4.8. If your project is on an earlier version, this functionality is not available.

Zapier is an Integration Provider as a Service (IPaaS) that enables automated interactions between Brightspot and third-party applications. While the possibilities of this integration are up to your individual business requirements, consider the following scenarios:

• Create an equivalent Google Doc whenever an article in Brightspot is published or translated.
• Create an equivalent Brightspot asset whenever a Google Doc is added to a certain folder in Google.
• Create a Salesforce campaign whenever a newsletter in Brightspot is published.
• Log workflow transitions in Microsoft Excel.
• Use a spreadsheet to import tags into Brightspot.

Currently, Brightspot has implemented three different components of a Zapier workflow (referred to as a zap):

• Trigger—Webhooks and polling.
• Search—Finds more data.
• Action—Takes an action, like saving an asset in Brightspot.

For more information on which integrations are available to Zapier (like Google Docs, Salesforce, and Microsoft Excel), see Zapier apps.

Note

The Brightspot Zapier connector is currently a private connection. Please contact your Brightspot contact for an invitation to access.

Overview of the configuration process

Note

These topics cover the Brightspot end of configuration, as well as how you can use Brightspot in various ways as you make Zapier workflows, referred to as zaps. For details on how to use Zapier, please refer to Zapier online help.

To configure the Zapier integration, you take the following steps:

1. Create API endpoints in Brightspot. Depending on whether you are using GraphQL, the second endpoint you create may vary (see How GraphQL relates to Zapier). For details on the configuration of these endpoints, see Adding API endpoints for the Zapier integration.

2. Create an API client in Brightspot, and link it to the previous endpoints. For details, see Adding an API client for the Zapier integration.

3. Using credentials from the API client, connect Brightspot to Zapier in the Zapier console. For details, see Adding API endpoints for the Zapier integration.

4. Build triggers, search queries, and actions in Brightspot for use in Zapier zaps. Depending on whether you are using GraphQL, the objects you create may vary (see How GraphQL relates to Zapier). For details, see the following topics:

   • Creating a topic subscription for the Zapier integration
   • Creating a GraphQL polling trigger for the Zapier integration (GraphQL only)
   • Creating a GraphQL query for the Zapier integration (GraphQL only)
   • Creating a GraphQL mutation for the Zapier integration (GraphQL only)
   • Creating a general Zapier search

After these configuration steps are complete, all additional configuration happens in the Zapier console. For details on that process, please refer to Zapier online help.

Including Zapier in a Brightspot build

The following table lists the dependencies to include in your build configuration.

Note

The Zapier tool uses timeseries for request analytics. Ensure that you have a timeseries implementation dependency included in your build, such as com.psddev:timeseries-mysql.

Artifact	Description
com.psddev:zapier	Exposes core Zapier functionality for configuration.
com.psddev:zapier-graphql	Enables GraphQL-powered searches, mutations, and polling triggers.
com.psddev:zapier-topic-webhook	Enables notification-based webhook triggers.