API and webhooks

Connect Ciarem to your own systems with an API and webhooks

Manage contacts and your CRM setup, read conversations and send WhatsApp templates from your code. Webhooks tell your server the moment a contact, conversation or message changes, signed and retried.

Start your free 14-day trial
  • No credit card. Cancel anytime.

Availability: API access and webhooks are included on Growth (10 requests per second) and Scale (20 per second), and open during the 14-day free trial (5 per second). Solo doesn't include them.

Integrations that hold together

  1. Our CRM and Ciarem drift apart, and someone reconciles them in a spreadsheet.

    1. Contacts have full create, read, update and delete over the API, and contact webhooks carry the whole contact.

  2. Our system knows when an order ships, but the WhatsApp message is sent by hand.

    2. Send an approved template to one recipient or a hundred in a single call, then follow what happened to each.

  3. We poll for changes every few minutes and still miss things.

    3. Webhooks send each event to your server within seconds and retry failures for up to 3 days.

One REST API for your CRM and WhatsApp

Keys belong to your organization, not to a person, so they keep working when a teammate leaves. Every endpoint reference is generated from the live contract, and changes are additive and listed in the changelog.

  • Contacts: create, read, update and delete
  • CRM: custom properties and funnel stages
  • Conversations: read the message history
  • WhatsApp templates: create them, check what a send needs, and send
  • Broadcasts: follow every recipient, or cancel

Webhooks the moment something changes

Give Ciarem an HTTPS URL, pick the events you care about or leave Send all events on, and each matching event arrives as a POST within seconds. Contact events carry the whole contact, so most integrations never need to call back.

  • Contacts created, updated, deleted or merged
  • Funnel stage and owner changes
  • Conversations created, assigned and closed
  • Every inbound customer message
  • Submitted WhatsApp forms, with the answers

Signed, retried and logged

Every request carries a Ciarem-Signature header you check with the endpoint's signing secret. A failed delivery is retried with longer waits for up to 3 days, every attempt is kept in the delivery log for 30 days, and you can send a delivery again or fire a test event at any time.

Built to retry safely

Every response carries your rate-limit budget in its headers, so you can pace without counting calls. Template sends accept an Idempotency-Key, so a retry after a timeout never sends twice, and one send call counts as one request whether it carries one recipient or a hundred.

How to get started

Start building

  1. 01

    Create an API key

    An admin opens Settings, then API keys. Copy the secret when it's shown: Ciarem stores only a hash and shows it once.

  2. 02

    Add a webhook endpoint

    In Settings, then Webhooks, click Add endpoint, paste your HTTPS URL, pick the events and store the signing secret.

  3. 03

    Send a test event

    Open the endpoint, choose an event under Test event and click Send test event. Ciarem shows what your server answered.

Frequently asked questions

Growth, at 10 requests per second, and Scale, at 20. It's open during the 14-day free trial at 5 per second so you can build before you pay. Solo doesn't include it.

Yes, approved WhatsApp templates, to one recipient or up to a hundred in a single call. You can then follow what happened to every recipient.

No. Webhooks are part of API access on Growth, Scale and the trial, with up to 10 endpoints per organization.

Each request is signed in the Ciarem-Signature header with your endpoint's secret, which starts with whsec_. Verify it before you trust the body.

Failed deliveries are retried with growing waits for up to 3 days, with the same event id. An endpoint where every delivery fails for 3 days in a row is turned off until you enable it again.

In the Ciarem help center, under API reference. Every endpoint is generated from the live contract, so what you read is what the API serves.

Related features

Your next customer already wrote to you.

Try Ciarem free for 14 days and see it answer with your information before your customers do.

Start your free 14-day trial
  • No credit card. Cancel anytime.