org.tangled.event.notifyEvent Documentation (EN)

main procedure

notify an event from external source

Input

Encodingapplication/json

event union Required

Tangled event object

repo stringdid Required

Repository DID

Output

Encodingapplication/json

ci ref#ciOutput Optional

No description available.

Errors

InvalidRequest Invalid request parameters

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": "notify an event from external source",
  "errors": [
    {
      "description": "Invalid request parameters",
      "name": "InvalidRequest"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "event": {
          "description": "Tangled event object",
          "refs": [
            "org.tangled.ci.trigger.manual",
            "org.tangled.event.push"
          ],
          "type": "union"
        },
        "repo": {
          "description": "Repository DID",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "repo",
        "event"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "ci": {
          "ref": "#ciOutput",
          "type": "ref"
        }
      },
      "required": [],
      "type": "object"
    }
  },
  "type": "procedure"
}

ciOutput object

No description available.

Properties

message string Optional

Text returned by the server for this push, like how to follow a started CI.

maxLength: 1000 bytes

pipelines array of stringrecord-key Optional

IDs of the scheduled pipelines

View raw schema

{
  "properties": {
    "message": {
      "description": "Text returned by the server for this push, like how to follow a started CI.",
      "maxLength": 1000,
      "type": "string"
    },
    "pipelines": {
      "description": "IDs of the scheduled pipelines",
      "items": {
        "format": "record-key",
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}