Skip to content
Swingback, home

API referenceBeta

Webhook events

Every event a webhook endpoint can receive, with the fields it adds to data and an example message.

Each event is a POST of JSON to your endpoint, with the same envelope: its type, when it happened, your workspace's id, and its data. To add an endpoint, check signatures and handle retries, see Webhooks.

Download the OpenAPI specJSON

The message#

What a webhook endpoint receives. data holds the event's own fields (ids and states) and a snapshot of its subject: post, comment, vote (with its post) or changelog_entry. The snapshot is taken when the message is queued, a moment after the event, and a replay sends it unchanged. It's null if the subject was deleted for good in between. Messages never include people's names or emails: look them up with the API.

Body

application/json
  • typestring

    The event's type, or webhook.test.

  • timestampstring · date-time

    When the event happened.

  • workspace_idstring

    Your workspace's id.

    Starts with ws_

  • dataobject

    The event's fields and its subject's snapshot. A test message has only a message.

Headers

  • webhook-idstring

    The message's id, which is the event's id: the same on every attempt and replay. Deduplicate on it.

  • webhook-timestampstring

    The attempt's time, in Unix seconds.

  • webhook-signaturestring

    v1, followed by the base64 HMAC-SHA256 of id.timestamp.body. During a secret rotation, two signatures, separated by a space.

Your response

Return any 2xx within 15 seconds to accept the message. A 410 Gone turns the endpoint off; anything else is retried. A test (webhook.test) is tried once, and never turns the endpoint off. Responses and retries gives the schedule, and Verify the signature shows how to check a message.

Example

Headers
POST /swingback HTTP/1.1
Content-Type: application/json
webhook-id: evt_01h455vb4pex5vsknk084sn02q
webhook-timestamp: 1790933400
webhook-signature: v1,<base64 HMAC-SHA256>
Body · webhook.test
{
  "type": "webhook.test",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "message": "This is a test from Swingback."
  }
}

post.created#

A post was created.

Sent for each new post, wherever it comes from, except an import: imported posts send no events. A post that's held for review as soon as it's written sends this event too, with moderation_state set to held.

Fields of data

  • author_idstring

    The end user who wrote the post, or for whom it was created.

    Starts with user_

  • board_idstring

    The board the post is on.

    Starts with board_

  • moderation_statestring

    Only for a post written in the portal or the widget: approved, or held when it waits for your team's review.

    One ofapprovedheld
  • numberinteger

    The post's number in the workspace.

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.created
{
  "type": "post.created",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "author_id": "user_01h455vb4pex5vsknk084sn02q",
    "board_id": "board_01h455vb4pex5vsknk084sn02q",
    "moderation_state": "approved",
    "number": 42,
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "pending",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 0,
      "comment_count": 0,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.updated#

A post's title, text, board, visibility or attachments changed.

Fields of data

  • changedarray of strings

    What changed, in this order. A new title gives the post a new slug too, and attachments means its images changed.

    Each one oftitleslugbody_mdboard_idvisibilityattachments

    At least 1 itemNo duplicates

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.updated
{
  "type": "post.updated",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "changed": [
      "title",
      "slug"
    ],
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV and Excel",
      "slug": "export-reports-to-csv-and-excel",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv-and-excel",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.status_changed#

A post's status changed.

The post's history keeps each change, with its note: see List a post's status changes.

Fields of data

  • fromstring

    The status before the change.

    One ofpendingreviewplannedin_progresscompletedclosed
  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

  • status_change_idstring

    The change, as the post's status history lists it.

    Starts with change_

  • tostring

    The status after the change.

    One ofpendingreviewplannedin_progresscompletedclosed

Example

post.status_changed
{
  "type": "post.status_changed",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "from": "planned",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "in_progress",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "status_change_id": "change_01h455vb4pex5vsknk084sn02q",
    "to": "in_progress"
  }
}

post.tags_changed#

A post's tags changed.

Fields of data

  • addedarray of strings

    The tags added.

    Each starts with tag_

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

  • removedarray of strings

    The tags removed.

    Each starts with tag_

  • sourcestring

    Only when the AI tagging added the tags: ai. It adds tags and never removes them.

    One ofai

Example

post.tags_changed
{
  "type": "post.tags_changed",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "added": [
      "tag_01h455vb4pex5vsknk084sn06v"
    ],
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "removed": []
  }
}

post.merged#

A post was merged into another.

The snapshot is the post that was merged. Its votes and comments moved to the other post, so it counts none.

Fields of data

  • into_post_idstring

    The post it was merged into.

    Starts with post_

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.merged
{
  "type": "post.merged",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "into_post_id": "post_01h455vb4pex5vsknk084sn03r",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 0,
      "comment_count": 0,
      "merged_into_id": "post_01h455vb4pex5vsknk084sn03r",
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.unmerged#

A merged post was unmerged.

The post gets its votes and comments back from the post it was merged into.

Fields of data

  • from_post_idstring

    The post it was merged into until now.

    Starts with post_

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.unmerged
{
  "type": "post.unmerged",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "from_post_id": "post_01h455vb4pex5vsknk084sn03r",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.deleted#

A post was moved to the trash.

Moving a board to the trash hides its posts without a post.deleted for each.

Fields of data

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.deleted
{
  "type": "post.deleted",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": "2026-10-02T09:30:00.000Z"
    }
  }
}

post.restored#

A post was restored from the trash.

Fields of data

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.restored
{
  "type": "post.restored",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.approved#

A held or rejected post was approved.

Fields of data

  • fromstring

    The moderation state before the decision.

    One ofheldrejected
  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.approved
{
  "type": "post.approved",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "from": "held",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.rejected#

A post was rejected.

Fields of data

  • fromstring

    The moderation state before the decision.

    One ofapprovedheld
  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

Example

post.rejected
{
  "type": "post.rejected",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "from": "held",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "rejected",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

post.held#

An approved post was held for review.

The AI moderation held it, or its author edited it in the portal and the edit needs review. A post that's held as soon as it's written sends post.created instead.

Fields of data

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

  • reasonsarray of strings

    Why the post is held, as its moderation_flags say: approval (the workspace reviews posts first), sensitive_data, links (too many links), ai (the AI moderation found something) or ai_unavailable (it couldn't judge a guest's post).

    Each one ofapprovalsensitive_datalinksaiai_unavailable

    At least 1 itemNo duplicates

Example

post.held
{
  "type": "post.held",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "held",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 17,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "reasons": [
      "ai"
    ]
  }
}

comment.created#

A public comment was created.

Sent for public comments and replies, on private posts too: the snapshot doesn't say whether its post is private, so read the post (post_id) before you show the comment. Internal notes never reach webhooks.

Fields of data

  • author_idstring

    The end user who wrote the comment, or for whom it was written.

    Starts with user_

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

  • mentionedarray of strings

    Only when the comment mentions people: the end users it mentions. A team member mentioned is their end user, of kind team.

    Each starts with user_

  • moderation_statestring

    held when the comment waits for your team's review.

    One ofapprovedheld
  • parent_idstring

    Only on a reply: the comment it replies to.

    Starts with comment_

  • post_idstring

    The post the comment is on.

    Starts with post_

Example

comment.created
{
  "type": "comment.created",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "author_id": "user_01h455vb4pex5vsknk084sn04s",
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for quarterly reports too.",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "moderation_state": "approved",
    "post_id": "post_01h455vb4pex5vsknk084sn02q"
  }
}

comment.updated#

A public comment's text or attachments changed.

Fields of data

  • changedarray of strings

    What changed: the text (body_md), its images (attachments), or both, in this order.

    Each one ofbody_mdattachments

    At least 1 itemNo duplicates

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

  • mentionedarray of strings

    Only when the edit mentions people the comment didn't mention before: those end users.

    Each starts with user_

Example

comment.updated
{
  "type": "comment.updated",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "changed": [
      "body_md"
    ],
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for yearly reports too.",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

comment.deleted#

A public comment was moved to the trash, or, for one published from an issue, deleted for good.

Its replies are hidden with it, without a comment.deleted for each. A comment published from a GitHub or Linear issue has no trash: when its original is deleted, its issue unlinked or its copy replaced, it's deleted for good, and the message's comment is null: the message then names no comment, and has no id to match.

Fields of data

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

Example

comment.deleted
{
  "type": "comment.deleted",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for quarterly reports too.",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": "2026-10-02T09:30:00.000Z"
    }
  }
}

comment.restored#

A public comment was restored from the trash.

Fields of data

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

Example

comment.restored
{
  "type": "comment.restored",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for quarterly reports too.",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

comment.approved#

A held or rejected comment was approved.

Fields of data

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

  • fromstring

    The moderation state before the decision.

    One ofheldrejected

Example

comment.approved
{
  "type": "comment.approved",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for quarterly reports too.",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "from": "held"
  }
}

comment.rejected#

A comment was rejected.

Fields of data

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

  • fromstring

    The moderation state before the decision.

    One ofapprovedheld

Example

comment.rejected
{
  "type": "comment.rejected",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for quarterly reports too.",
      "moderation_state": "rejected",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "from": "held"
  }
}

comment.held#

An approved comment was held for review.

The AI moderation held it. A comment that's held as soon as it's written sends comment.created instead, and one held by its author's edit sends comment.updated, with moderation_state: held in its snapshot.

Fields of data

  • commentobjectnullable

    The comment, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (12)
    • idstring

      Starts with comment_

    • author_idstring

      The end user who wrote the comment.

      Starts with user_

    • body_mdstring

      The comment's Markdown. A mention is the person's token, such as <@user_…>.

    • heart_countinteger

      How many likes the comment has.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • parent_idstringnullable

      The comment this one replies to, or null for a top-level comment.

    • pinnedboolean

      Whether your team pinned the comment to the top of its post.

    • post_idstring

      The post the comment is on.

      Starts with post_

    • sourcestring

      Where the comment came from: dashboard, api, portal or import, as on the comment object. github and linear mark a comment someone wrote on a linked issue in that tracker.

      One ofdashboardapiportalimportgithublinear
    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the comment is in the trash.

  • reasonsarray of strings

    Why the comment is held, as its moderation_flags say: ai (the AI moderation found something) or ai_unavailable (it couldn't judge a guest's comment).

    Each one ofaiai_unavailable

    At least 1 itemNo duplicates

Example

comment.held
{
  "type": "comment.held",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "comment": {
      "id": "comment_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "parent_id": null,
      "body_md": "We need this for quarterly reports too.",
      "moderation_state": "held",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn04s",
      "pinned": false,
      "heart_count": 0,
      "created_at": "2026-10-02T09:30:00.000Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "reasons": [
      "ai"
    ]
  }
}

vote.created#

An end user voted for a post.

Fields of data

  • end_user_idstring

    The end user who voted.

    Starts with user_

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

  • post_idstring

    The post voted for.

    Starts with post_

  • voteobject

    The vote.

    Child fields (3)
    • idstring

      Starts with vote_

    • end_user_idstring

      The end user who voted.

      Starts with user_

    • post_idstring

      The post voted for.

      Starts with post_

Example

vote.created
{
  "type": "vote.created",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "end_user_id": "user_01h455vb4pex5vsknk084sn04s",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 18,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "post_id": "post_01h455vb4pex5vsknk084sn02q",
    "vote": {
      "id": "vote_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "end_user_id": "user_01h455vb4pex5vsknk084sn04s"
    }
  }
}

vote.deleted#

An end user's vote was removed.

Fields of data

  • end_user_idstring

    The end user whose vote was removed.

    Starts with user_

  • postobjectnullable

    The post, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (17)
    • idstring

      Starts with post_

    • author_idstring

      The end user who wrote the post.

      Starts with user_

    • boardobject

      The post's board.

      Child fields (3)
      • idstring

        The board's id.

        Starts with board_

      • namestring

        The board's name.

      • visibilitystring

        public for everyone, or private for your team only: customers see neither the board nor its posts.

        One ofpublicprivate
    • comment_countinteger

      How many live, public, approved comments the post has.

    • merged_into_idstringnullable

      The post this one was merged into, or null.

    • moderation_statestring

      approved, held for your team's review, or rejected.

      One ofapprovedheldrejected
    • numberinteger

      The post's number in the workspace: 1, 2, 3...

    • slugstring

      The post's slug, which url ends with.

    • sourcestring

      Where the post came from: dashboard (your team, in the dashboard), api (an API key or the MCP server), portal (someone on the portal or in the widget), import (an import) or slack (made from Slack, with the command or the shortcut).

      One ofdashboardapiportalimportslack
    • statusstring
      One ofpendingreviewplannedin_progresscompletedclosed
    • titlestring

      The post's title.

    • urlstring

      The post's address in the portal.

    • visibilitystring

      public for everyone. private hides the post from other customers: only your team and the post's author see it, and the author still gets notifications about it. A post on a private board is hidden from customers whatever its visibility.

      One ofpublicprivate
    • vote_countinteger

      How many votes the post has.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the post is in the trash.

  • post_idstring

    The post the vote was for.

    Starts with post_

  • voteobject

    The vote.

    Child fields (3)
    • idstring

      Starts with vote_

    • end_user_idstring

      The end user who voted.

      Starts with user_

    • post_idstring

      The post voted for.

      Starts with post_

Example

vote.deleted
{
  "type": "vote.deleted",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "end_user_id": "user_01h455vb4pex5vsknk084sn04s",
    "post": {
      "id": "post_01h455vb4pex5vsknk084sn02q",
      "number": 42,
      "title": "Export reports to CSV",
      "slug": "export-reports-to-csv",
      "status": "planned",
      "board": {
        "id": "board_01h455vb4pex5vsknk084sn02q",
        "name": "Feature requests",
        "visibility": "public"
      },
      "visibility": "public",
      "moderation_state": "approved",
      "source": "portal",
      "author_id": "user_01h455vb4pex5vsknk084sn02q",
      "vote_count": 16,
      "comment_count": 3,
      "merged_into_id": null,
      "url": "https://acme.w.swingback.dev/posts/export-reports-to-csv",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "post_id": "post_01h455vb4pex5vsknk084sn02q",
    "vote": {
      "id": "vote_01h455vb4pex5vsknk084sn02q",
      "post_id": "post_01h455vb4pex5vsknk084sn02q",
      "end_user_id": "user_01h455vb4pex5vsknk084sn04s"
    }
  }
}

changelog_entry.published#

A changelog entry was published.

Sent when an entry is published, at once or at its scheduled time.

Fields of data

  • changelog_entryobjectnullable

    The entry, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (11)
    • idstring

      Starts with entry_

    • slugstring

      The entry's slug, which url ends with.

    • statusstring

      draft, scheduled (to be published at publish_at) or published.

      One ofdraftscheduledpublished
    • summarystring

      Plain text, for lists, feeds and emails.

    • titlestring

      The entry's title.

    • urlstring

      The entry's address in the portal.

    • whisperboolean

      Whether the entry is published quietly: it's never announced or marked unread.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the entry is in the trash.

    • published_atstring · date-timenullable

      When the entry was last made public.

  • first_publicationboolean

    Whether it's the entry's first publication: false when an entry that went back to draft is published again.

  • whisperboolean

    Whether the entry is published quietly: it's never announced or marked unread.

Example

changelog_entry.published
{
  "type": "changelog_entry.published",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "changelog_entry": {
      "id": "entry_01h455vb4pex5vsknk084sn02q",
      "title": "CSV exports are here",
      "slug": "csv-exports-are-here",
      "summary": "Export any report to CSV in one click.",
      "status": "published",
      "whisper": false,
      "published_at": "2026-10-02T09:30:00.000Z",
      "url": "https://acme.w.swingback.dev/changelog/csv-exports-are-here",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    },
    "first_publication": true,
    "whisper": false
  }
}

changelog_entry.unpublished#

A published changelog entry went back to draft.

Sent when a published entry goes back to draft. Unscheduling an entry that wasn't published yet sends nothing.

Fields of data

  • changelog_entryobjectnullable

    The entry, as it was when the message was queued, a moment after the event. null if it was deleted for good in between.

    Child fields (11)
    • idstring

      Starts with entry_

    • slugstring

      The entry's slug, which url ends with.

    • statusstring

      draft, scheduled (to be published at publish_at) or published.

      One ofdraftscheduledpublished
    • summarystring

      Plain text, for lists, feeds and emails.

    • titlestring

      The entry's title.

    • urlstring

      The entry's address in the portal.

    • whisperboolean

      Whether the entry is published quietly: it's never announced or marked unread.

    • created_atstring · date-time
    • updated_atstring · date-time
    • deleted_atstring · date-timenullable

      Set while the entry is in the trash.

    • published_atstring · date-timenullable

      When the entry was last made public.

Example

changelog_entry.unpublished
{
  "type": "changelog_entry.unpublished",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "changelog_entry": {
      "id": "entry_01h455vb4pex5vsknk084sn02q",
      "title": "CSV exports are here",
      "slug": "csv-exports-are-here",
      "summary": "Export any report to CSV in one click.",
      "status": "draft",
      "whisper": false,
      "published_at": null,
      "url": "https://acme.w.swingback.dev/changelog/csv-exports-are-here",
      "created_at": "2026-09-28T14:03:12.482Z",
      "updated_at": "2026-10-02T09:30:00.000Z",
      "deleted_at": null
    }
  }
}

webhook.test#

A test message your team sent from the dashboard.

Sent when your team clicks Send a test on an endpoint's page, to check your receiver. It's tried only once, and it has no snapshot.

Fields of data

  • messagestring

    The test's message: This is a test from Swingback.

Example

webhook.test
{
  "type": "webhook.test",
  "timestamp": "2026-10-02T09:30:00.000Z",
  "workspace_id": "ws_01h455vb4pex5vsknk084sn02q",
  "data": {
    "message": "This is a test from Swingback."
  }
}

Search pages, sections and code: a setting, an event, a method.