How to Create a Webhook?

Webhooks are automated messages sent from one app to another in case something happens or something is updated/changed. Example: if you want to send all transactions from the circuly operations backend to your bookkeeping system (tool) you can do that via Webhooks. In your circuly operations backend, you can now access Webhooks. You will find them in the left main menu under Admins.
‍

‍

How it works?

In order for circuly to make the requested information available to you we need a URL where the information can be sent (pushed) to. The URL can be generated by tools like Zapier or it can be one of your API endpoints. Make sure that the URL where you want the information to be sent to, can be caught by circuly. To ensure that, make sure that URL allows a POST request since circuly PUSHES the information to your specified URL. Once you create an event for the information you want, circuly will push the information to the URL specified by you and will also push any changes made to the event.

How to create a webhooks in the circuly operations backend?

To create a web hook:

• Go to Webhooks and click on CREATE WEBHOOK.

‍

• In the Create Webhook window select an Event for which you want information.

At present Events can be created for customer, order, order item, subscription and transaction.

‍

‍

• In the URL field attach the URL of the receiving app (URL generated by tools like Zapier or from your API endpoint).

‍

Bonus

How Webhook works with Zapier?

In Zapier you can create a new Zap and say that the source is a webhook. On doing that Zapier will generate a URL that you can paste in the URL field of the Create Webhook window in your circuly operations backend.

‍

Figure out what information is fired

You can use websites like Webhook.site to check what information is being fired.