Lexicon Garden

org.tangled.webhook.createWebhook

Create a new webhook for a repository.

Repository @tangled.org did:plc:wshs7t2adsemcrrd4snkeqli namespace authority
Details · procedure
Kindprocedure
Authoritywebhook.tangled.org
Indexed
Compare Edit in builder → Fork →
cid bafyreic6azwej3o7y66cq2kgr7q7je7zz5dmj6lhintgv4vhriuuduxtz4

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.secretNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.idNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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"
    }
  },
  "id": "org.tangled.webhook.createWebhook",
  "lexicon": 1
}