# @socialsflow/trigger-activitypub

> Actionsflow trigger for ActivityPub

Latest version **1.0.0** (published 2023-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @socialsflow/trigger-activitypub
pnpm add @socialsflow/trigger-activitypub
yarn add @socialsflow/trigger-activitypub
bun add @socialsflow/trigger-activitypub
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-12-17 |
| First published | 2023-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 30.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ric Wood |
| Maintainers | rgladwell |
| Keywords | activitypub, actionsflow, trigger |

## Links

- npm: https://www.npmjs.com/package/@socialsflow/trigger-activitypub
- Repository: https://github.com/actionsflow/actionsflow-trigger-example
- Issues: https://github.com/rg-wood/actionsflow-trigger-activitypub/issues/new
- npm.io page: https://npm.io/package/@socialsflow/trigger-activitypub

## Dependencies (4)

- [html-to-text](https://npm.io/package/html-to-text.md) ^9.0.5
- [actionsflow-core](https://npm.io/package/actionsflow-core.md) ^1.5.4
- [typed-rest-client](https://npm.io/package/typed-rest-client.md) ^1.8.11
- [@types/html-to-text](https://npm.io/package/@types/html-to-text.md) ^9.0.4

## Recent versions

- 1.0.0 (latest) — 2023-12-17

## README

# `@actionsflow/activitypub-trigger`

This is an [Actionsflow](https://github.com/actionsflow/actionsflow) trigger for ActivityPub.

## Install

```bash
npm i @actionsflow/trigger-activitypub
```

## Usage

```yaml
on:
  activitypub:
    host: example.org
    user: test
```

## Options

- `host`, required, hostname of source ActivityPub instance
- `user`, required, source user account

> You can use [General Config for Actionsflow Trigger](https://actionsflow.github.io/docs/workflow/#ontriggerconfig) for more customization.

## Outputs

This trigger's outputs will be the following object.

An outputs example:

```json
{
  "uri": "uniqueId",
  "message": "hello world title",
  "replyto": "optionalUniqueReplyId"
}
```

You can use the outputs like this:

```yaml
jobs:
  print:
    name: Print
    runs-on: ubuntu-latest
    steps:
      - name: Print Post Outputs
        env:
          uri: ${{on.activitypub.outputs.uri}}
          message: ${{on.activitypub.outputs.message}}
          reply: ${{ on.activitypub.outputs.replyto}}
        run: |
          echo uri: $uri
          echo message: $message
          echo reply: $reply
```

---
_Source: https://npm.io/package/@socialsflow/trigger-activitypub · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._