Brightspot Integrations Guide

Adding API endpoints for the Zapier integration


The first step of configuring the Zapier integration is adding two API endpoints —a GraphQL endpoint and a Zapier endpoint, both of which you can add in Brightspot. Each endpoint serves a different purpose:

  • The Zapier endpoint is needed to connect Brightspot to Zapier in the Zapier console.
  • The GraphQL endpoint is needed to perform queries and mutations on Brightspot data for use in Zapier workflows (referred to as zaps).

To add a Zapier API endpoint:

  1. Click menu > Admin > APIs.
  2. From the Create list, select Zapier Endpoint, then click New.
  3. Retain the default Name and Path.
  4. Click Save.

Once created, note the full URL of the Zapier endpoint (for example: https://"your-brightspot-domain".com/api/zapier), as you will need it when connecting Brightspot to Zapier. For details, see Connecting a Brightspot environment to a Zapier account.

To add a GraphQL endpoint for the Zapier integration:

  1. From the Create list, select GraphQL Content API Endpoint, then click New.
    Note
    You can technically use any GraphQL endpoint type; these topics assume you are using a GraphQL Content API endpoint.
  2. In the Name field, enter a name for the endpoint.
  3. Under Schema Settings, under Read/Write Types, select the content types that you want to expose to Zapier. For example, if you want to allow Zapier to at some point in the zap create articles, select Article. Select as many content types as needed.
  4. Under API Access, retain the default selection API Key Required.
  5. Click Save.

Once you have added the APIs, you must create an API client. For details, see Adding an API client for the Zapier integration.

Previous Topic
How GraphQL relates to Zapier
Next Topic
Adding an API client 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.

Asset types
Module types
Page types
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