Disclaimer: This feature is not available to all customers. Please contact [email protected] for more information and to request access.

This article can help you identify the use case for your organisation. The following guide provides a list of the most used endpoints and webhooks by our installer partners. Going through this list you will be in a good position to define your organisation's requirements.

What are Endpoints?

API endpoints serve as the entry points to a computer program or website, much like doors to a house. When you wish to interact with this software, these "doors" (endpoints) act as your means of communication. Each endpoint corresponds to a distinct room (function) within the "house" (software).

To engage with these endpoints, you initiate contact by sending a message in the form of an HTTP request, and in response, the software provides you with the information or action you requested. Each door (endpoint) possesses a unique name, represented by a URL, and follows specific rules denoted by HTTP methods, governing how they can be utilized.

This concept is similar to perusing a menu at a restaurant. Each item on the menu corresponds to an endpoint, signifying something you can order or do with the software. In this analogy, you communicate your preferences to the waiter (API), who then fulfills your request.

Our Most Popular EndPoints

• Create project

• Retrieve panel arrays

• Retrieve production estimates

• Retrieve proposal

• Get site assessment data

• User management

• Project Management

• Retrieve project information

What are Webhooks?

API webhooks are like messages that different apps send to each other when something important happens. Think of it as a notification. When one app does something, it tells another app about it by sending a message. This helps apps work together and stay updated without constantly checking for new information. It's a bit like getting a text message when your favorite team scores a goal – you know about it as soon as it happens, without having to keep checking the score.

Our Most Popular Webhooks

• Proposal signed

• Docusign contract signed

• Project created

Read the articles below to learn more about Solargraf's API integration:

• API Integration

• Generating API Keys

You can also find our documentation API documentation here: https://developer.solargraf.com/