The Notification API provides a one-way computer-to-computer interface to automatically notify partners and/or suppliers when specific events occur on the Ecologic platform.

Some common use cases include:

  • automatically create a contact in your CRM when a user profile is created
  • automatically generate project leads in your CRM tool when a project is created on the platform

The Notification API provides a webhook interface to provide maximum flexibility to partners and suppliers. After specifying the notification type as 'webhook' and providing a webhook URI, the platform will send the requested data as JSON.

For a library of easily configurable webhook integrations with most popular off-the-shelf CRM tools we recommend Zapier. For high volume or custom integrations we recommend either developing the integration yourself on AWS Lambda or commissioning us to help you.

Available events

Event Description
Audit:Create the creation of an audit
Audit:Simulate the simulation of an audit
Audit:Assign the assignment of an audit to a different user
Audit:Label:Apply the assignment of a new status label to an audit
RequestQuote:Create the creation of a new quote request
RequestQuote:Label:Apply the assignment of a new status label to a quote request

The following table provides a field set description for RequestQuote:Create

Field Description
action action code e.g. 'solar_pv'
supplier_name supplier name e.g. 'ACME products'
offer_title offer code e.g. '3 kW Standard Solar Package'
offer_description offer description
offer_price price listed against the product or service requested by the customer
first_name customer first name as string
last_name customer last name as string
street customer street address as a combined string
postcode customer address postcode component
state customer address state component
country customer address country component
reply_email reply email address provided by the customer
reply_phone reply phone number provided by the customer
comments comments provided by the customer

The Management API provides a two-way computer-to-computer interface for partners to directly query, create and update records in the Ecologic platform without using the web client. Some use cases include:

  • querying data collected by the platform
  • querying actions and impacts arising from the platform
  • updating the status of projects when updates are made on external CRM software

HMAC is applied for authentication, security and data integrity. Valid URLs must include an 8-byte random hex nonce ("_"), an ISO formatted expiry datetime ("expiry") and signature ("sig"). The HMAC signature uses a SHA256 hash and 64 byte encoding.

API keys may be generated / revoked by team admins via the team admin console.

A set of Zapier integrations have been developed to allow the most common actions to be readily implemented.

Available actions

Action Endpoint