·¬ÇÑÉçÇø

Brightspot Integrations Guide

Creating a GraphQL polling trigger for the Zapier integration


At times, Brightspot may not have a topic type for the scenario in which you want Brightspot to initiate a Zapier zap (for example, you have a task that creates a record in the database each time it runs, and you do not have an associated topic type for this record). In these scenarios, you can use a polling trigger to notify Zapier about the new record.

Polling triggers periodically check for updates or changes in data at specified intervals. They serve as a way for Zapier to ask Brightspot if new data of a certain type exists at a certain interval. In this case, GraphQL polling triggers require that a GraphQL query returns data in chronological order and with a unique ID so that Zapier knows that it is a new record.

Note
Brightspot recommends that you use a webhook trigger whenever possible, as they are more performant than polling triggers.


To create a GraphQL polling trigger for the Zapier integration:

  1. Click menu > Admin > Zapier.
  2. From the Create list, select GraphQL Polling Trigger, then click New.
  3. Enter an internal name for this asset. Brightspot uses this name internally, such as in the search panel and recent activity widget. This name is not visible to visitors to your site.
  4. In the Description field, enter a description about what this polling trigger achieves.
  5. In the Zapier Label field, enter a value that will appear when creating actions in Zapier. Use something short but descriptive of the what the query achieves (for example, Publish New Article).
  6. Under Endpoint, select the GraphQL API endpoint you added that you associated to the API client. For details, see Adding Zapier endpoints for the Zapier integration.
  7. Under Query, enter the desired query. Brightspot recommends using the GraphQL explorer to more easily build the query from the schema.
    Note
    To use the GraphQL explorer, you must have the developer permission HTML Toggle.
  8. Under Results Path, enter the appropriate keys to flatten the response so that it is at the root level. A raw response causes the polling trigger to fail.
  9. Click Publish.
Note
Once published, you may view analytics pertaining to this asset in the Analytics tab. The tab includes when it was last used, its success count, the number of its total requests, and the number of errors it has generated.

Previous Topic
Creating a topic subscription for the Zapier integration
Next Topic
Creating a GraphQL query for the Zapier integration
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

•
•
•
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

• Content types
• Modules
• Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

• Dashboards
• Publishing
• Workflows
• Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

• Field types
• Content modeling
• Rich-text elements
• Images
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

• Google Analytics
• Shopify
• Apple News