Skip to main content

Vote Webhook | Climes API

This webhooks fires an event whenever your user votes to one of the projects using the Vote Link or Climes are Paid to Projects or Climes are getting Retired.

Webhooks (Web Callback, HTTP Push API or Reverse API) are one way that a web application can send information to another application in real-time when a specific event happens.

Example​

Suppose you have subscribed to the ALLOCATION webhook event, you will receive a notification every time a user chooses a project to finance using his/her Climes.

Webhook Vs API​

APIs send you the data when you request it. For Webhooks, you do not need to make a request. You receive the data when it is available.

Example​

If you need to know whether a allocation has happened or not, using APIs, you need to keep polling every few seconds until someone allocates. However, if you are using Webhooks, you can configure a webhook event ALLOCATION to receive notifications when a user chooses a project to finance using his/her Climes.

When to Use Climes Webhooks​

You can use Climes Webhooks to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL.

Use Cases​

There can be multiple uses for webhook events. Three of them are listed below :

Capturing Climes Allocation Events​

Once the Order is created using Create Order API's then using Vote Links users can vote on which project their climes can be allocated to so see their favorite project getting funded.

Upon allocation, an ALLOCATION event will be automatically sent via webhook endpoint to your servers. This event will have the required details regarding the user, allocation and order.You can use this data and do some interesting things like engaging with users or sending them notifications for the events, etc.

Capturing Climes Money Transfer Events​

Once the Climes are allocated, their finances are paid to the chosen project developers monthly/quarterly as per the contracts. So you can use TRANSFER event to engage with your users updating them about their finances being moved.

This event occurs from Climes Side either every month or quarter depending upon external factors. Once the Climes' are Money Transferred to the respective project the events are fired immediately.

You can view their certificates at [Individual Project Pages under Updates Section].

Capturing Climes Retired Events​

Once the Climes are Money Transferred to the Respective projects, the project developers issues a retirement certificate authenticating that the Climes are retired and will not be used again.

When the RETIRED event is fired, you can use this event to send the updates to your users that their Climes for their chosen projects are now retired.