API changelog

Every API and webhook change is recorded here. Breaking changes only ship in a new version (/api/v2) and are announced here in advance.

  1. 2026-10-26
    Added

    Create or update a contact in one request

    • POST /contacts/upsert: updates the contact the business’s identity keys match (mobile, then email, by default), or creates one.
    • The response is { created, contact }.
  2. 2026-10-24
    Added

    Appointment events

    • Two new webhook events: booking.created and booking.cancelled.
  3. 2026-09-27
    Added

    Signed webhooks

    • 16 events for contacts, companies, leads, products, deals, orders and forms.
    • HMAC-SHA256 signature in the Reshta-Signature header.
    • Retries for about 24 hours; disabled after 20 failures in a row, without dropping deliveries.
  4. 2026-09-27
    Added

    Public API v1

    • Contacts, companies, deals and orders: list, retrieve, create and update; plus notes on contacts, companies and deals.
    • API keys with Read or Read & write access; 120 requests per minute per key.
    • Idempotency-Key is required on every write request.
    • Connection → Developer in the app: create and revoke keys, webhooks, delivery history and Replay.
    • OpenAPI file at /api/v1/public/openapi.json.

Planned

These modules are being built and have no public endpoints yet. As soon as a module’s endpoints appear in the OpenAPI file, it leaves this list and goes live in the API reference by itself.

  • LeadsSoon
  • ProductsSoon
  • ActivitiesSoon
  • AppointmentsSoon
  • PaymentsSoon
  • FormsSoon
  • FieldsSoon
  • CallsSoon
  • MessagesSoon

Create an API key and send your first request

Keys are created in the Reshta app and shown once. The API and webhooks (beta) are on the Pro and Enterprise plans, and only a business admin can create a key.

  1. 1Sign in at app.reshta.ir
  2. 2Connection → Developer
  3. 3Create API key