Create a webhook subscription

Redline API›Webhook subscriptions

POSThttps://api.redline.example/v1/webhook-subscriptions

AuthRequires authentication via bearerAuth.

Description

Creates a signed event delivery destination and returns its signing secret once.

Request

cURLJavaScriptPython

Copy

curl -X POST "https://api.redline.example/v1/webhook-subscriptions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://contracts.asterpeak.example/hooks/redline",
  "events": [
    "matter.turn_completed",
    "matter.executed",
    "approval.requested"
  ]
}'

const response = await fetch("https://api.redline.example/v1/webhook-subscriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "url": "https://contracts.asterpeak.example/hooks/redline",
      "events": [
        "matter.turn_completed",
        "matter.executed",
        "approval.requested"
      ]
    }),
});

import requests

response = requests.post(
    "https://api.redline.example/v1/webhook-subscriptions",
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
    json={
      "url": "https://contracts.asterpeak.example/hooks/redline",
      "events": [
        "matter.turn_completed",
        "matter.executed",
        "approval.requested"
      ]
    },
)

Response201JSONCopy

{
  "id": "whs_01JAZ92C4Q",
  "url": "https://contracts.asterpeak.example/hooks/redline",
  "events": [
    "matter.turn_completed",
    "matter.executed",
    "approval.requested"
  ],
  "status": "active",
  "created_at": "2026-07-01T17:10:00Z",
  "signing_secret": "whsec_••••••••••••••••"
}

Request body

application/jsonrequired

urlbodystring <uri>required

Public HTTPS delivery destination.

eventsbodystring[]required

Responses

201The created subscription. Store the signing secret securely because it is not shown again.application/json

401The API key is missing, malformed, expired, or revoked.application/json

errorobjectrequired

403The API key does not have permission for this action.application/json

errorobjectrequired

422One or more request fields are invalid.application/json

errorobjectrequired