Webhooks

WebWorkstation

Webhooks send signed HTTPS requests to an external endpoint when selected ZynoSuite events occur. Use them when another system needs to react to your organization's activity.

Open this page from Admin > Integrations > Webhooks.

Create an endpoint

1. Select Add Endpoint.
2. Enter a name that identifies the destination.
3. Enter its HTTPS URL.
4. Select the event types that should trigger a delivery. A supported wildcard selects events in that event namespace.
5. Leave Enabled selected when the receiver is ready, then select Create.
6. Copy and securely store the signing secret shown after creation.

ZynoSuite shows the plaintext signing secret only when you create or rotate it. Store it in the receiving system before closing the dialog.

Test, monitor, and retry

Use an endpoint's actions menu to send a test event, enable or disable delivery, edit the endpoint, or open Delivery history. A test uses the normal durable delivery path, so it is useful for checking both the receiving endpoint and the event configuration.

Delivery history shows the 100 most recent deliveries for that endpoint, including status, attempts, HTTP response, and the most recent error. Open a delivery for attempt details and response content.

For a failed delivery, select Retry delivery. For a scheduled retry, select Retry now to skip the wait. A successful delivery also offers Replay delivery. Replays reuse the original event ID, so the receiving system must deduplicate by that ID.

Rotate a signing secret

Open an endpoint and select Rotate secret. Update the receiving system with the new value immediately. The previous and new secret both verify deliveries for 24 hours, which gives you time to update the receiver without stopping delivery.

Related

• Admin Panel Overview
• Permissions