POST https://api.usecommune.comhighlight.created Production. There is no separate sandbox host.

Highlight created

A reader marked a passage of an article.

No user_id. A highlight is never attributed to a named reader anywhere in Commune, so this payload carries the same opaque owner_key GET /highlights/{highlight} does. It is the one topic whose payload cannot be resolved back to a person.

Fires on a new highlight only. Re-marking the same span of the same article is silent. So is attaching a chat message to a highlight that already exists, which is how a passage becomes a discussion; that fires message.created for the message instead.

A highlight created together with its discussion carries data.message_id from the start. One created on its own carries null and never gains a value on this topic.

A passage of a tag-scoped article can only be marked by someone in its audience.

Delivered as a single HTTPS POST to the consumer's registered endpoint, with the message as the JSON request body. Respond 2xx to acknowledge. Anything else, or a timeout, is retried with backoff, so acknowledge fast and do the work afterwards.

Request Headers

  • string Required
  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • integer

Body

A reader marked a passage of an article.

  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • string(uuid) | null Required
  • string | null Required
POST highlight.created
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-onhighlightcreated

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.