Skip to content
Sursa Developers

Events · Collaboration

announcement.read

Announcement read

A recipient confirmed reading a must-read announcement.

Object type
announcement
Delivered to
Endpoints that can see the object: by role, data profile and collections

Payload

Object: EventAnnouncementRead

  • idstringrequired

    Event ID (evt_…), also sent as the webhook-id header. Use it to drop duplicate deliveries.

  • typestringrequired

    Allowed values: announcement.read

  • created_atstring (date-time)required

    When the change happened (UTC).

  • org_idintegerrequired
  • api_versionstringrequired

    Contract version of the data schema.

  • sequenceinteger

    Delivery sequence number within the endpoint (absent for a test event).

  • objectWebhookEventObjectrequired
  • payloadstringrequired

    thin means no data: read the object through the API.

    Allowed values: fullthin

  • dataobject
    Fields
  • testbooleanrequired

    A test event sent by POST /v1/webhooks/{webhook_id}/test.

Example delivery

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "announcement.read",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "announcement",
    "id": "12"
  },
  "payload": "full",
  "data": {
    "announcement": {
      "id": 12,
      "card_id": "c_9f2e41"
    },
    "user_id": 11
  },
  "test": false
}

Receiving events

Each delivery is a POST request with this JSON body to your endpoint. Verify the webhook-signature header (Standard Webhooks) before you trust the body, answer with a 2xx status within a few seconds, and do the work afterwards. Deliveries to one endpoint keep the order of events; a failed delivery is retried with growing pauses.

New event types and new fields can appear at any time: skip the types and fields you do not know.

The same events are in the event feed for 30 days →