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:
- Click > Admin > APIs.
- From the Create list, select Zapier Endpoint, then click New.
- Retain the default Name and Path.
- 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:
-
From the Create list, select GraphQL Content API Endpoint, then click New.NoteYou can technically use any GraphQL endpoint type; these topics assume you are using a GraphQL Content API endpoint.
- In the Name field, enter a name for the endpoint.
- 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.
- Under API Access, retain the default selection API Key Required.
- 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