https://github.com/socialflows/actionsflow-trigger-activitypub

Actionsflow trigger for ActivityPub
https://github.com/socialflows/actionsflow-trigger-activitypub

actionsflow activitypub social social-media

Last synced: 3 months ago
JSON representation

Actionsflow trigger for ActivityPub

• Host: GitHub
• URL: https://github.com/socialflows/actionsflow-trigger-activitypub
• Owner: socialflows
• Created: 2023-12-15T11:56:39.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-17T17:16:05.000Z (about 1 year ago)
• Last Synced: 2024-09-30T06:41:38.977Z (3 months ago)
• Topics: actionsflow, activitypub, social, social-media
• Language: TypeScript
• Homepage:
• Size: 288 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `@actionsflow/activitypub-trigger`

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

## Install

```bash

npm i @actionsflow/trigger-activitypub --save

```

## 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

```

## Limitations

Please note that:

* **Direct replies only.** By design, the trigger will only fire for direct replies from the original account owner.

* **30 minute Cutoff.** Similarly, the trigger will ignore any posts made within a cutoff period of half-an-hour. Any posts made before `T - 30` will be ignored to prevent accidental spamming.

* **No media.** We do not currently support media attachments.

* **No polls.** We do not currently support poll posts.

* **Public only.** We only support public ActivityPub posts.

* **English only.** We  currently only support posts using the `en` (English) language code.