How GraphQL relates to Zapier
Brightspot uses GraphQL as one out-of-the-box implementation of the Zapier integration. To use GraphQL with Zapier, you must include the GraphQL-related dependency listed in Zapier, and then take the following route:
- In Brightspot, in addition to creating a Zapier API endpoint, create a GraphQL API endpoint (see Adding API endpoints for the Zapier integration).
- Create an API client to be used by the Zapier API endpoint (see Adding an API endpoint for the Zapier integration).
- Create one or more of the following based on the zap you are creating:
- Topic subscription (trigger) to initiate a zap (see Creating a topic subscription for the Zapier integration).
- Polling trigger (trigger) to initiate a zap (see Creating a GraphQL polling trigger for the Zapier integration).
- Query (search) to fetch more data from Brightspot (see Creating a GraphQL query for the Zapier integration).
- Mutation (action) to take an action in Brightspot (see Creating a GraphQL mutation for the Zapier integration).
All other configuration happens in the Zapier console.
Note
If you do not want to use GraphQL, you can take the following route:
- In addition to creating a Zapier endpoint, create a different kind of endpoint in the area described in Adding API endpoints for the Zapier integration.
- Create an API client to be used by the Zapier endpoint (see Adding an API endpoint for the Zapier integration).
- Create a topic subscription to serve as the first step (the trigger) of your Zapier zap (see Creating a topic subscription for the Zapier integration).
- Create a general Zapier search to fetch more data from Brightspot using a different query language that you define in Zapier (see Creating a general Zapier search).
Previous Topic
Zapier
Next Topic
Adding API endpoints for the Zapier integration