Developer docs

Use our developer docs to integrate APIs and Webhooks with Zixflow.

Zixflow, being a fully customizable platform, allows you to make use of API integrations and make the platform fit your needs. 

We use REST APIs and basic HTTP request methods. Our APIs accept JSON for encoded body requests and return data in the same form.

How to set up your API?

To get started, click your Workspace name on the top left corner and select the Settings option. Next, click the Developer option under the Workspace label in the sidebar.

Click the "+Add New" button and enter your API’s name, expiration date, and other desired permissions. Once done, click the Add button.

After you have successfully created your API, you can refer to our API documentation and start integrating immediately.

How to set up Webhooks?

Webhooks are a powerful way to automate your workflows and make the most of Zixflow. A Webhook gives you instant notifications about changes to your data so that you always stay on top of the latest information.

Instead of requiring you to pull information through our API, Webhooks will push the information to your endpoint. When any of these events are triggered, Zixflow sends you the notification as an HTTP POST request with a JSON body, at the termination point you specify.

To get your Webhooks up and running, click your Workspace name on the top left corner and select the Settings option. Next, click the Developer option under the Workspace label in the sidebar. After that, go to the Webhook tab.

Next, click +Add New and enter a name for your Webhook, specify the endpoint, select the actions where you want to activate the Webhook, and the Webhook type.

Once added, validate the same at the endpoint and your Webhooks are ready to use.

To learn more about Webhooks check out our Webhooks Documentation