org.tangled.webhook.createWebhook Documentation (EN)

main procedure

Create a new webhook for a repository.

Input

Encodingapplication/json

active boolean Optional

Whether the webhook should be active immediately.

events array Required

Event types to subscribe to.

repo stringdid Required

DID of the repository as minted by the knot.

secret string Optional

Optional HMAC secret used to sign payloads. If omitted, payloads are not signed.

url stringuri Required

Endpoint URL that will receive webhook payloads.

Output

Encodingapplication/json

id string Required

ID of the newly created webhook.

Errors

NoEventsSelected At least one event type must be specified.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Create a new webhook for a repository.",
  "errors": [
    {
      "description": "At least one event type must be specified.",
      "name": "NoEventsSelected"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "active": {
          "default": true,
          "description": "Whether the webhook should be active immediately.",
          "type": "boolean"
        },
        "events": {
          "description": "Event types to subscribe to.",
          "items": {
            "ref": "org.tangled.webhook.defs#eventType",
            "type": "ref"
          },
          "type": "array"
        },
        "repo": {
          "description": "DID of the repository as minted by the knot.",
          "format": "did",
          "type": "string"
        },
        "secret": {
          "description": "Optional HMAC secret used to sign payloads. If omitted, payloads are not signed.",
          "type": "string"
        },
        "url": {
          "description": "Endpoint URL that will receive webhook payloads.",
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "repo",
        "url",
        "events"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "id": {
          "description": "ID of the newly created webhook.",
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}