Skip to content

Webhooks send real-time notifications from Zimark to your endpoint when specific events occur.

Webhooks are HTTP callbacks sent to your endpoint when triggered events occur. This eliminates polling and enables real-time synchronization with your systems.

Supported Event Types:

  • Manifest Events: Status changes, updates, asset dispatch status change
  • Gate Events: Status changes, unauthorized loading added, unauthorized loading resolved

Create a Webhook

Prerequisites

  • ✅ HTTPS endpoint accessible to receive POST requests
  • ✅ Ability to parse JSON payloads and return 200/201/202 status codes
  • ✅ Endpoint responds within 30 seconds
  • ✅ Handle duplicate deliveries using eventIdentifier (see Webhooks)

Step 1: Navigate to Webhook Configuration

  1. Log into your Zimark administration panel
  2. Navigate to AdministrationWebhooks
  3. Click "Add webhook"

Step 2: Configure Basic Settings

Webhook Configuration Form

Required Fields:

  • Name: Description for this webhook configuration
  • Webhook URL: Your HTTPS endpoint (e.g., https://your-domain.com/webhooks/zimark)
  • Event Types: Select which events trigger this webhook
  • Active Status: Enable or disable the webhook

Step 3: Configure Authentication (Optional)

Add custom headers if your endpoint requires authentication:

Webhook Form with Authentication

Security: Always use HTTPS endpoints and implement authentication.

Step 4: Configure Retry Policy (Optional)

Retry Policy Configuration

Retry Options:

  • Maximum Retries: Number of retry attempts for failed deliveries (default: 3)
  • Retry Intervals: Duration between retries using exponential backoff
  • Backoff Strategy: Constant or exponential interval calculation