Webhook Delivery

Estimated reading time: less than 1 minute

Webhook Delivery provides real-time notifications about workflow and task execution events.

Instead of polling the API, your system can subscribe to webhook events and receive updates automatically when something changes.

🎯 Introduction

Webhooks are designed for operational visibility and event tracking.

They notify your system when key events occur during workflow execution, such as:

  • Workflow started
  • Workflow completed
  • Workflow failed
  • Task started
  • Task completed
  • Task cancelled

These events allow your backend to react in real time without continuously querying the system.

⚙️ How Webhooks Work

When a subscribed event occurs, ShareRing LINK sends an HTTP POST request to your configured webhook endpoint.

Each webhook event includes:

  • Workflow run ID
  • Task run ID (if applicable)
  • Event type
  • Status and timestamps

⚠️ Webhooks do not include end-user data. They only provide metadata about execution state.

🔧 Configure a Webhook

To configure a webhook:

  1. Navigate to Developer → Webhooks
  2. Create a new webhook endpoint
  3. Provide your endpoint URL
  4. Select the event types you want to subscribe to
  5. Save and enable the webhook

Each webhook can be configured with:

  • Signing key (for request validation)
  • Event subscriptions
  • Enable/disable status

🧾 Webhook Payload

Webhook payloads contain execution metadata only.

Typical payload fields include:

  • event_type (e.g. workflow_run.completed)
  • run_id
  • task_id (optional)
  • status
  • timestamp

These payloads are designed to help your system:

  • Track workflow progress
  • Trigger follow-up processes
  • Monitor system behavior

📊 Webhook Logs

The Webhook Logs page allows you to monitor delivery attempts.

Each log entry includes:

  • Event name
  • Target endpoint
  • Delivery status (success / failed)
  • Timestamp

This helps you:

  • Debug failed webhook deliveries
  • Verify integration correctness
  • Monitor system reliability

⚖️ Webhook vs Delivery HTTP

It is important to distinguish between Webhook Delivery and Delivery HTTP (workflow task).

FeatureWebhookDelivery HTTP
PurposeEvent notificationData delivery
ScopeAll workflows in the organizationSpecific workflow
TriggerOn event (e.g. run completed)When workflow reaches delivery node
DataMetadata only (no user data)Full verification data
ConfigurationDeveloper settingsWorkflow editor

Key Difference

  • Webhook → tells you what happened
  • Delivery HTTP → sends you what was collected

💡 Best Practices

  • Always validate webhook signatures
  • Ensure your endpoint responds quickly
  • Implement retry handling for failed deliveries
  • Log webhook requests for debugging

🚀 Summary

Webhooks provide a lightweight and scalable way to monitor workflow execution in real time.

They complement Delivery HTTP by offering event-level visibility, while Delivery HTTP handles data transfer.