API and webhooks

Connect ZyfrHub to the rest of your tools

Create an API key to read and write opportunities, contacts, organisations, leads and more, and send events out with webhooks when something changes. It's included on Growth and Pro.

14 days of the full Pro plan. No card needed. From $19 a user a month (AUD, GST included, billed yearly).

What you get

A REST API

Covers opportunities, contacts, organisations, leads, activities, notes, products, pipelines, custom fields, sales orders and tickets, with every path described in an OpenAPI file.

API keys you control

Owners and admins create and revoke keys. A key acts as the person who made it, with their permissions, and each key can make 1,200 requests a minute.

Signed webhooks

Choose the events you want, send them to a public https address, and verify each message with its signature. Failed deliveries are retried and listed in a delivery log.

Works with Zapier and Make

Use their web request and webhook steps with your API key and webhook address to connect thousands of other apps.

How it works

  1. 1Open Settings › API & webhooks and create a key.
  2. 2Add a webhook address and choose the events.
  3. 3Connect it in Zapier or Make, or call the API directly.

Read the guides

Questions

Which plans include it?

The API and webhooks are included on Growth and Pro and in your free trial. Starter doesn't include them.

Is there a ZyfrHub app in Zapier or Make?

Not yet. Use their web request or webhook steps with your API key and webhook address.

Is it safe?

Keys are shown once and can be revoked, and webhooks carry a signature you can check. A key only does what its creator is allowed to do.