মূল অংশে যান

Developer API and webhooks

সর্বশেষ হালনাগাদ ৩১ অক্টোবর, ২০২৬ · এই গাইডটি শুধু ইংরেজিতে পাওয়া যায়।

Before you start

  • The API and webhooks are for developers. The Owner has access, and a custom role can be given the Developer tools permission. See Team and roles. People without it see a page saying so.
  • You find both under Connections, in the Developer group: API keys and Webhooks.

Create an API key

  1. Open Connections, then API keys, and choose Create key.
  2. Give it a name that says what it is for, for example Accounting sync.
  3. Choose the access: Read only or Read and write.
  4. Copy the secret key now. Wizn keeps only a fingerprint, so you will not see it again. If you lose it, make a new one.

The table shows each key's name, access, who created it, when it was last used, and a Revoke button. Revoking stops software using that key right away.

Use the API

Send the key as a bearer token on every request to /api/public/v1:

Authorization: Bearer <your key>

The key decides which business you reach. With read access you can list and open contacts, conversations and their messages, tickets, leads and orders. With write access you can also create and update contacts, send a message in a conversation as a person, and create tickets and leads. Lists are paged with a cursor and a limit. Reading data through the API does not use AI replies.

Requests are rate limited per key, with a higher allowance for reads than for writes. When you go over, the API answers with a retry-later error.

Receive webhooks

  1. Open Webhooks and choose Add endpoint.
  2. Enter your address. It must start with https://.
  3. Choose the events you want: contact created, conversation started, conversation handed to a person, message received, lead created, ticket created or order created.
  4. Copy the signing secret. It is shown once.
  5. Use Send test event to check your server answers. The result appears in the Delivery log.

Every delivery is a JSON message with three headers: Wizzen-Event (the event), Wizzen-Delivery (the delivery id) and Wizzen-Signature. The signature looks like t=<unix seconds>,v1=<hex>, where the hex value is an HMAC-SHA256 of the timestamp, a dot and the raw body, made with your signing secret. Recompute it on your side, compare, and reject old timestamps.

Retries and the delivery log

Your server should answer quickly with a 2xx status. If it does not, Wizn tries again later, with longer waits between tries, over about a day. The Delivery log of each endpoint shows every attempt with its time, response code, duration and status (delivered, pending, retrying or failed). Entries are kept for a limited time.

After many failures in a row, the endpoint is paused and shows Paused after repeated failures. Fix your server, then switch the endpoint on again. You can also switch an endpoint off yourself, edit its events, or delete it.

Good to know

  • Keep API keys and signing secrets private. Anyone with a key can use the API with its access. Revoke a key that is exposed.
  • Your workspace has a limit on the number of keys and endpoints.
  • For a chat widget on your own website or app, see Connect the website widget.

If something goes wrong

  • The Developer group is missing. Your role may not include Developer tools. Ask the Owner.
  • Your server does not receive events. Check the address is public, uses https and answers quickly, then look at the delivery log.
  • The signature does not match. Use the exact signing secret shown for that endpoint and the raw request body, before any parsing.
  • A request is refused. Check the key is not revoked and that it has write access for write calls.

Still stuck? Write to [email protected].

এখনও সাহায্য লাগবে?

কী করতে চাইছেন আমাদের জানান, একজন মানুষ ইমেইলে উত্তর দেবেন।

যোগাযোগ করুন