Skip to main content

Set Up and Edit Webhooks | Climes API

Set Up Webhooks​

To set up webhooks :

  1. Login to your Climes Partner Dashboard
  2. Click on Webhooks in the navbar to go to Webhooks page.
  3. From the list of available webhooks, add Endpoint and Authorization to any of the webhooks listed.
  4. If you want to make the webhook available, toggle the enable option.
  5. Click on Save button to save the configuration.
tip

You can add any Authorization Key in the Partner Dashboard which you can use to verify the authenticity of the webhook when its gets delivered to you.

caution

Be cautious while changing the configuration of webhook, i.e. Endpoint, Authorization, Enable and Disable because they will be updated immediately and the consequent requests will be as per the newly updated configuration.

Types of Webhook Events​

There are three types of webhook events available.

Allocation Event Webhook​

This event will be fired when a user allocates his/her Climes to any of the projects.
You can get more detailed information here

Money Transfer Event Webhook​

This event will be fired when the user's Climes are paid to project developer.
You can get more detailed information here

Retired Event Webhook​

This event will be fired when the user's Climes are retired by the project developer.
You can get more detailed information here

Edit a Webhook​

You can edit your webhook to replace the webhook endpoint, modify the authorization key, enable / disable the webhookk.

To edit webhooks :

  1. Login to your Climes Partner Dashboard
  2. Click on Webhooks in the navbar to go to Webhooks page.
  3. From the list of available webhooks, edit Endpoint and/or Authorization to any of the webhooks listed.
  4. If you want to make the webhook available/unavailable, toggle the option accordingly.
  5. Click on Save button to save the configuration.
caution

Be cautious while changing the configuration of webhook, i.e. Endpoint, Authorization, Enable and Disable because they will be updated immediately and the consequent requests will be as per the newly updated configuration.

Enable/Disable a Webhook​

You can enable/disable a webhook immediately.

To enable/disable a webhook :

  1. Login to your Climes Partner Dashboard
  2. Click on Webhooks in the navbar to go to Webhooks page.
  3. From the list of available webhooks, toggle any of the webhooks to enable/disable them.
  4. Click on Save button to save the configuration.