API Documentation

Instead of writing code that calls the Vibrate API, let Vibrate call yours. An automation pulls a list of people from any URL that returns JSON on a schedule, and sends each of them an approved WhatsApp template - once. Built for appointment reminders, order updates and lead follow-ups.

How it works

1. 1.Source

   The API URL (GET or POST), query parameters, headers that carry your API key, and a request body. Header values are encrypted and never shown again after saving.

2. 2.Extraction

   Where the list lives in the response, where the phone number is inside each item, a display name, filters, and a "same person" key that prevents double sends.

3. 3.Message

   A WhatsApp number, an approved template, and one variable per {{N}} in the template. Each variable is text with placeholders taken from the item.

4. 4.Schedule

   How often to call the API (5 minutes minimum), a send window in Israel time, and how often the same person may be messaged again.

5. 5.Approval

   By default every batch waits for approval: you see each person and the exact message, then press Send. In auto mode messages go out as soon as the list is ready.

Example: a reminder for tomorrow's appointment

Say your booking system answers /appointments?from={{today+1}}&to={{today+1}} with this response:

{
  "data": [
    {
      "id": "apt_18233",
      "status": "confirmed",
      "startTime": "2026-09-09T07:00:00.000Z",
      "customer": {
        "firstName": "דנה",
        "lastName": "לוי",
        "mobile": "050-1234567"
      }
    },
    {
      "id": "apt_18234",
      "status": "cancelled",
      "startTime": "2026-09-09T08:30:00.000Z",
      "customer": {
        "firstName": "יוסי",
        "lastName": "כהן",
        "mobile": "052-7654321"
      }
    }
  ]
}

Result: Dana receives "Hi Dana, a reminder for your appointment tomorrow, 09/09/2026 at 10:00". The Preview tab shows exactly this before anything is sent.

Date placeholders in the request

Most APIs expect a date range, and every vendor spells it differently. Write the vendor's format around placeholders that are filled at request time, in Israel time. They work in the URL, query parameters, headers and body. Each one takes a day offset: {{today+1}}, {{startOfDay-7}}.

Placeholders in the message

The name, the "same person" key and the template variables are free text with three kinds of placeholder:

• {{fieldKey}}A field you defined under "Fields to extract". Resolved first, so {{firstName}} is shorter than a raw path and also becomes a column in the recipients list.
• {{item.path}}Any path inside the raw item, arrays included: {{item.customer.phones[0]}}.
• {{index}}The item's position in the response, starting at 1.

Why someone does not get a message

Every item read from the response goes through these checks, in order. The first reason that matches is shown next to the item in the preview and in the run, so the preview is exactly what the run will do.

Limits and safety

• Interval between calls: 5 minutes to 90 days. The scheduler ticks every 5 minutes, so a run can start up to 5 minutes late.
• Up to 300 messages per run. Whatever is left goes out in a follow-up run 5 minutes later.
• Up to 5,000 items are read from one response. The response is capped at 8MB and 20 seconds.
• Every recipient is written to the ledger before WhatsApp is called. Even if a run crashes halfway, the same person never receives the message twice.
• A batch waiting for approval expires after 7 days, and no new batch is prepared while one is open.
• Test mode sends everything to your own number, 5 messages per run, without marking customers as messaged.
• Approved non-OTP templates only, on the same business account as the number. Messages go through the same path as the send API and show up in sent messages and in the inbox.