Test your webhook on your computer

The webhook address must be public. While they develop, your developers get the App’s events on their computer with the Zean CLI, and you send test events from the dashboard.

Create the CLI key

1. Open App settings > Developers > Webhook.
2. In “CLI key”, choose “Create a CLI key”.
3. Copy the key, which starts with zk_cli_, and give it to your developer. It is private: it is not the App key.

If it may have leaked, choose “Regenerate”, then confirm: every running Zean CLI stops at once.

Send a test event

1. Your developer runs the Zean CLI with the CLI key. While none runs, “Test events” shows the command to copy.
2. They open the chat from a development build of your app or site: Expo Go, a React Native development build or a site on localhost. The device shows under “Your test device”, for example an iPhone in Expo Go, seen 2 minutes ago. Pick another one of the most recent if needed.
3. Pick the event, then “Send a test event”. The button stays off while no Zean CLI runs.
4. The result shows in “Recent deliveries”, with the “Test” badge.

What a test sends

• A test event never goes to the webhook address: your production server never gets a test, and no real Contact is notified.
• It carries your test device’s Contact. Without a test device, a sample Contact.
• For a Member’s reply, once the test device has written, Zean writes a real test reply in its conversation: the push notification and the badge are real. It is marked “Test reply” in the inbox; no AI reads it and the stats do not count it.
• A real event also goes to every running Zean CLI, as well as to the webhook address.

The command, its options and the Listen secret: Documentation > Receive webhooks on your computer.

Developers is for Admins and the Owner only. Up to 5 Zean CLIs can run at once for one App.