ActivitySmith GitHub Action

The official ActivitySmith GitHub Action is now live on the GitHub Marketplace.

Connect your CI and deployment workflows directly to ActivitySmith so your team gets real-time updates on their mobile devices.

You can now:

Send push notifications from any workflow step.
Start, update, and end Live Activities as your pipeline progresses.

Push Notifications

For lightweight updates like deploy completed, build failed, or rollback started, send a push notification in a single step:

1
- name: Send push notification
2
  uses: ActivitySmithHQ/activitysmith-github-action@v1
3
  with:
4
    action: send_push_notification
5
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
6
    payload: |
7
      title: "ActivitySmith Deployment"
8
      message: "New release deployed to production."

This is a good fit for one-off alerts where you want immediate visibility but no ongoing activity timeline.

Live Activities

For long-running workflows, start the activity, post as many progress updates as needed, then end it when complete.

These examples use the current @v1 stream actions. Reuse a key based on repository, run, and run attempt for every update. No activity ID needs to be stored.

1
- name: Start live activity
2
  uses: ActivitySmithHQ/activitysmith-github-action@v1
3
  with:
4
    action: stream_live_activity
5
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
6
    stream-key: workflow-${{ github.repository_id }}-${{ github.run_id }}-${{ github.run_attempt }}
7
    payload: |
8
      content_state:
9
        title: "ActivitySmith API Deployment"
10
        subtitle: "ci: install & build"
11
        number_of_steps: 3
12
        current_step: 1
13
        type: "segmented_progress"
14
15
- name: Update live activity
16
  uses: ActivitySmithHQ/activitysmith-github-action@v1
17
  with:
18
    action: stream_live_activity
19
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
20
    stream-key: workflow-${{ github.repository_id }}-${{ github.run_id }}-${{ github.run_attempt }}
21
    payload: |
22
      content_state:
23
        title: "ActivitySmith API Deployment"
24
        subtitle: "ci: tests"
25
        current_step: 2
26
        type: "segmented_progress"
27
        number_of_steps: 3
28
29
- name: End live activity
30
  if: ${{ always() }}
31
  uses: ActivitySmithHQ/activitysmith-github-action@v1
32
  with:
33
    action: end_live_activity_stream
34
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
35
    stream-key: workflow-${{ github.repository_id }}-${{ github.run_id }}-${{ github.run_attempt }}
36
    payload: |
37
      content_state:
38
        title: "ActivitySmith API Deployment"
39
        subtitle: "${{ job.status == 'success' && 'done' || 'check the workflow run' }}"
40
        current_step: 3
41
        auto_dismiss_seconds: 10

ActivitySmith GitHub Action

Push Notifications

Live Activities

Ready to bring ActivitySmith into your workflow?