Skip to content
IPKit

register_webhook

Register an HTTPS endpoint to receive monitoring events as HTTP POST requests. Supports HMAC-SHA256 signature verification for secure delivery. Events are posted as JSON payloads.

Parameters

Section titled “Parameters”
ParameterTypeRequiredDescription
namestringYesHuman-readable name for this webhook (max 200 chars)
urlstringYesHTTPS endpoint URL to receive events
secretstringNoShared secret for HMAC-SHA256 signature verification (sent in X-Signature-256 header)
eventTypesstring[]NoEvent types to receive: status_change, similar_filing, deadline_approaching. Empty array = all types.

Example

Section titled “Example”

Request

Section titled “Request”
{
  "name": "register_webhook",
  "arguments": {
    "name": "Slack IP Alerts",
    "url": "https://hooks.slack.com/triggers/T0123/ipkit-alerts",
    "secret": "whsec_a1b2c3d4e5f6",
    "eventTypes": ["status_change", "similar_filing"]
  }
}

Response

Section titled “Response”
{
  "webhook": {
    "id": "wh_789abc012def",
    "name": "Slack IP Alerts",
    "url": "https://hooks.slack.com/triggers/T0123/ipkit-alerts",
    "hasSecret": true,
    "eventTypes": ["status_change", "similar_filing"],
    "enabled": true,
    "createdAt": "2024-03-04T10:00:00.000Z"
  },
  "message": "Webhook \"Slack IP Alerts\" registered. Events will be POSTed to https://hooks.slack.com/triggers/T0123/ipkit-alerts",
  "tip": "Verify deliveries using the X-Signature-256 header (HMAC-SHA256)."
}

Notes

Section titled “Notes”
  • Webhook payloads include: id, type, severity, summary, detectedAt, watchId, and details.
  • When a secret is provided, each delivery includes an X-Signature-256 header containing the HMAC-SHA256 hex digest of the payload body.
  • Deliveries are retried up to 3 times with exponential backoff on failure.
  • Empty eventTypes subscribes to all event types.
Section titled “Related Tools”