Skip to content

README.md

Latest commit

 

History

History
42 lines (33 loc) · 1.34 KB

README.md

File metadata and controls

42 lines (33 loc) · 1.34 KB
Raw

Webhook Plugin

The webhook plugin sends an HTTP request when the endpoint status changes.

Plugin config

{
  "url": "https://example.com/link-events",
  "resource_id": "resource-123",
  "secret": "shared-secret",
  "headers": {
    "Authorization": "Bearer my-token",
    "X-Custom": "custom-value"
  }
}
  • url is required and must use http or https.
  • resource_id is required and identifies the external resource tied to the webhook. Link derives the election key from resource_id, so endpoints configured with the same resource_id compete for the same activation lock. Only one Link instance will activate the endpoint for a given resource_id.
  • secret is required, stored encrypted, and used to sign webhook requests.
  • headers is optional and contains extra headers injected in the request.

Request payload

The plugin sends a POST request to url with a JSON body:

{
  "endpoint_id": "vip-...",
  "resource_id": "resource-123",
  "plugin": "webhook",
  "status": "ACTIVATED"
}

Requests include these Link headers:

  • X-Link-Webhook-Resource-ID: the resource_id from the plugin config. Consumers can use it to derive the webhook key before reading the request body.
  • X-Link-Webhook-Timestamp: Unix timestamp in seconds.
  • X-Link-Webhook-Signature: hex-encoded HMAC-SHA256 of "<timestamp>.<body>".