Webhook Configuration Guide

Webhooks allow your workspace to send real-time data to external services whenever specific events occur. Use this guide to configure your connection

1. General Settings

• Enabled Toggle: Use this switch to globally activate or deactivate the webhook.
• HTTP Method: Select the request type (typically POST) required by your receiving server.
• Endpoint URL: Enter the destination URL where the data should be sent (e.g., https://your-api.com/webhook).
• Subscribed Events: Choose the specific actions in the workspace that will trigger this webhook.
  • video-played, video-watched, player-opened, share-clicked, cta-clicked.

2. Custom Headers

If your receiving server requires specific metadata or security tokens, add them here.

• Default: Content-Type: application/json is standard for most integrations.
• Custom: Click + Add Header to include extra fields like User-Agent or custom API keys.

3. Authentication

Secure your webhook to ensures only authorized requests are processed by your server.

• Auth Type: Choose from common methods like Bearer Token, or API Key.
• Note: If you have already manually added credentials in the Headers section, you can leave this set to None.

4. Payload Configuration

This section defines exactly what data is sent to your endpoint.

• Payload Template (JSON): Write the structure of your data in JSON format. You can use placeholders (e.g., {{event_name}} or {{timestamp}}) to inject dynamic data from the event.
• Payload Preview: A real-time visualization of how your data will look once the placeholders are populated.