Payloads

Our COAR Notify Server is an implementation of the COAR Notify Protocol v1.0.1, please refer to their specification to identify all the required keys and their meanings.

This documentation will provide extra requirements for the kind of COAR Notifications we handle.

Mention of a software in a scientific publication

• id MUST be a UUID

• type indicate this is an Announce Relationship COAR Notification

• origin describes the system which has sent the notification

• target describes the system which is intended to receive the notification, our inbox for instance

• actor describes the party responsible for this activity

• object describes the relationship itself, subject is the identifier of your resource which cites/mentions our resource object (a SWHID or an origin URL)

• context identifies the resource on the origin which is the subject of the relationship

Here’s an example payload:

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://coar-notify.net"
  ],
  "id": "urn:uuid:6908e2d0-ab41-4fbf-8b27-e6d6cf1f7b95",
  "type": [
    "Announce",
    "coar-notify:RelationshipAction"
  ],
  "target": {
    "id": "https://www.softwareheritage.org",
    "inbox": "https://inbox.staging.swh.network",
    "type": "Service"
  },
  "actor": {
    "id": "https://your-organization.tld",
    "name": "Your Organization",
    "type": "Organization"
  },
  "context": {
    "id": "https://your-organization.tld/item/12345/",
    "sorg:name": "My paper title",
    "sorg:author": {
        "@type": "Person",
        "givenName": "Author Name",
        "email": "author@example.com",
    },
    "ietf:cite-as": "https://doi.org/XXX/YYY",
    "ietf:item": {
      "id": "https://your-organization.tld/item/12345/document.pdf",
      "mediaType": "application/pdf",
      "type": [
        "Object",
        "sorg:ScholarlyArticle"
      ]
    },
    "type": [
      "Page",
      "sorg:AboutPage"
    ]
  },
  "object": {
    "as:subject": "https://your-organization.tld/item/12345/",
    "as:relationship": "https://w3id.org/codemeta/3.0#citation",
    "as:object": " https://github.com/rdicosmo/parmap",
    "id": "urn:uuid:74FFB356-0632-44D9-B176-888DA85758DC",
    "type": "Relationship"
  },
  "origin": {
    "id": "https://your-organization.tld/repository",
    "inbox": "https://inbox.your-organization.tld",
    "type": "Service"
  }
}