Eznow Developers

The Eznow API

Read and change a business's clients, appointments and tasks, look up free times and start automations. It is what Zapier, Make and n8n use, and it works with any tool that can send HTTP requests.

Authentication

The business's owner creates a token in Settings › Integrations. Send it in every request. A token is either read-only or read-and-write, and belongs to one business: it only ever sees that business's data.

Authorization: Bearer 1|eznow_…
Accept: application/json

Basics

  • Base address: https://eznow.app/api/v1
  • JSON in and out. Times are ISO 8601 in the business's timezone; a time without an offset is read in that timezone.
  • Lists use cursor pagination: follow links.next.
  • 120 requests a minute per token; after that, 429 with a Retry-After header.
  • Errors: 401 bad token, 402 subscription ended, 403 missing access, 404 not found, 422 invalid data (with the reason per field).

Business

GET /api/v1/me any token

The business the token belongs to

A quick way to check that a token works.

Catalogue

GET /api/v1/services any token

Active services

GET /api/v1/staff any token

Active team members, with the services each one performs

GET /api/v1/availability any token

Free start times

service_ids[]
One or more service ids, performed back to back. Required.
from
First day, YYYY-MM-DD. Required.
to
Last day, YYYY-MM-DD; at most 14 days after "from".
staff_id
Only this team member.

Clients

GET /api/v1/clients any token

Clients, newest first

email
Exact email.
phone
Exact phone number.
search
Part of the name or email.
updated_since
Only clients changed since this date and time.
per_page
Up to 100; 25 by default.
GET /api/v1/clients/{id} any token

One client

POST /api/v1/clients read and write token

Find a client by email or phone, or create one

Answers 201 when the client is new and 200 when one with the same email or phone already existed. Set marketing_consent only when the client agreed to promotions.

{
    "first_name": "Ana",
    "last_name": "Silva",
    "email": "[email protected]",
    "phone": "+351912345678",
    "locale": "pt",
    "marketing_consent": false
}
PATCH /api/v1/clients/{id} read and write token

Change a client

{
    "phone": "+351912345678",
    "birthday": "1990-05-17"
}
POST /api/v1/clients/{id}/tags read and write token

Add tags

Tags the business does not have yet are created. Tagging can start automations.

{
    "tags": [
        "VIP",
        "Instagram"
    ]
}

Appointments

GET /api/v1/appointments any token

Appointments, latest first

from
Starting from this date and time.
to
Starting before this date and time.
status
pending, confirmed, completed, cancelled or no_show.
client_id
Only this client.
staff_id
Only this team member.
per_page
Up to 100; 25 by default.
GET /api/v1/appointments/{id} any token

One appointment

POST /api/v1/appointments read and write token

Book a free time

Give client_id for an existing client, or client with a name and an email or phone. Without staff_id, anyone free is booked. The time must be free, as on the booking page; the client gets the usual confirmation.

{
    "service_ids": [
        12
    ],
    "staff_id": 3,
    "starts_at": "2026-10-06T10:00:00+01:00",
    "client": {
        "first_name": "Ana",
        "email": "[email protected]"
    }
}
POST /api/v1/appointments/{id}/reschedule read and write token

Move to another free time

{
    "starts_at": "2026-10-07T15:30:00+01:00"
}
POST /api/v1/appointments/{id}/cancel read and write token

Cancel

{
    "reason": "Client asked by phone"
}
POST /api/v1/appointments/{id}/status read and write token

Mark as confirmed, completed or no-show

{
    "status": "completed"
}

Tasks and automations

POST /api/v1/tasks read and write token

Create a task for the team

{
    "title": "Call back about the wedding package",
    "client_id": 58,
    "due_at": "2026-10-06T09:00:00"
}
GET /api/v1/automations any token

Active automations

POST /api/v1/automations/{id}/runs read and write token

Start an automation for a client

Answers 409 when the client does not match the automation's filters or went through it too recently.

{
    "client_id": 58
}

Webhooks

In Settings › Webhooks the business adds an address and chooses events. Eznow then sends a POST with JSON to that address each time one happens. The address must be public https. A delivery counts when the address answers 2xx within 10 seconds; otherwise it is tried again after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours. After 20 failed deliveries in a row the webhook is switched off and the owners get an email. Deliveries are kept for 30 days and can be sent again.

Events

appointment.booked
A booking was made, online, in the panel, through the API or from an offer. data.appointment.
appointment.confirmed
The client or the team confirmed it. data.appointment.
appointment.rescheduled
It moved to another time. data.appointment.
appointment.cancelled
It was cancelled. data.appointment, with cancelled_by.
appointment.completed
It took place. data.appointment.
appointment.no_show
The client did not come. data.appointment.
client.created
A new client. data.client.
client.updated
Contact details, notes or consents changed. data.client and data.changed.
client.tagged
A tag was added. data.client and data.tag.
form.submitted
A lead form was sent. data.form, data.fields and data.client.
deal.stage_changed
A deal moved in the pipeline. data.deal and data.client.
offer.claimed
A smart calendar offer was booked. data.offer and data.appointment.
message.received
A client wrote on WhatsApp or by SMS. data.message and data.client.
ping
Sent by "Send a test". data.message.

What is sent

{
    "id": "01J9\u2026",
    "event": "appointment.booked",
    "created_at": "2026-10-06T09:12:03+00:00",
    "data": {
        "appointment": {
            "id": "9d3c\u2026",
            "status": "pending",
            "starts_at": "2026-10-07T10:00:00+01:00",
            "client": {
                "id": 58,
                "first_name": "Ana"
            }
        }
    }
}

Appointments and clients have the same shape as in the API. Headers: X-Eznow-Event, X-Eznow-Delivery (the same id if a delivery is tried again, to ignore repeats) and X-Eznow-Signature.

Checking the signature

The signature header looks like t=1791277923,v1=5f2c…: an HMAC-SHA256 of the time, a dot and the raw body, with the webhook's signing secret. Reject deliveries older than five minutes.

// PHP
[$t, $v1] = sscanf($_SERVER['HTTP_X_EZNOW_SIGNATURE'], 't=%d,v1=%s');
$expected = hash_hmac('sha256', $t.'.'.file_get_contents('php://input'), $secret);
$valid = hash_equals($expected, $v1) && abs(time() - $t) < 300;

// Node.js
const [, t, v1] = header.match(/^t=(\d+),v1=([a-f0-9]+)$/);
const expected = crypto.createHmac('sha256', secret).update(`${t}.${rawBody}`).digest('hex');
const valid = crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(v1));

Sending clients to an automation

An automation that starts with Another app sends a client to this automation has its own secret address. POST JSON or form fields to it: email or phone (one is needed), and first_name, last_name or name. The client is found or created and the automation starts; every field can be used in its messages as {{ webhook.field }}. It answers 202, or 422 without an email or phone. No token is needed: the address is the secret.