# org.tangled.event.notifyEvent

> Published by [tangled.org](https://lexicon.garden/identity/did:plc:wshs7t2adsemcrrd4snkeqli)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.event.notifyEvent)
- [Documentation](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.event.notifyEvent/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.event.notifyEvent/examples)

## Definitions

### `org.tangled.event.notifyEvent#ciOutput`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `message` | `string` | No | Text returned by the server for this push, like how to follow a started CI. |
| `pipelines` | `array` | No | IDs of the scheduled pipelines |

### `org.tangled.event.notifyEvent`

**Type**: `procedure`

notify an event from external source

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `event` | `union` | Yes | Tangled event object |
| `repo` | `string` (did) | Yes | Repository DID |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ci` | `ref` → `#ciOutput` | No |  |

#### Errors

- **InvalidRequest**: Invalid request parameters

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "ciOutput": {
      "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"
    },
    "main": {
      "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"
    }
  },
  "id": "org.tangled.event.notifyEvent",
  "lexicon": 1
}
```