> For the complete documentation index, see [llms.txt](https://academy.synap.ac/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.synap.ac/doc/integrations/webhooks/learning-record-webhooks.md).

# Learning Record Webhooks

{% hint style="info" %}
Learning Records available on Pro or higher plans
{% endhint %}

### Learning Record Created

Example payload from Learning Record Created webhooks

```
{
  "user": {
    "id": "7dNGUkKit2O",
    "name": "Charlotte Blue",
    "email": "charlotte+blue@synap.ac",
    "subPortalId": "rtQY0MErP9S",
    "customAttributes": {
      "employee-id": null,
      "team": null,
      "quote": null,
      "dob": null,
      "last-certified-grade": null,
      "checker": null,
      "boxes": null
    }
  },
  "portal": {
    "id": "9i0FAHIDOM"
  },
  "meta": {
    "timestamp": "2024-06-25T11:15:15.587Z",
    "eventName": "learningRecord.created"
  },
  "learningRecord": {
    "objectId": "lcfdxBQ13vT",
    "name": "The Smallest Record Who Ever Lived",
    "score": 55,
    "visibleToStudent": true,
    "achievedOn": "2024-06-03T23:00:00.000Z",
    "attr": {
      "grade": "c",
      "file": {
        "url": "https://synap-files-prod.s3.eu-west-1.amazonaws.com/9i0FAHIDOM/user/7dNGUkKit2O/learning-record-attr/file/luke.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA3EUWGFBCLXOGZ7TD%2F20240625%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240625T112807Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBQaCWV1LXdlc3QtMSJHMEUCIAxsi4LCDi6hYPyLTEULYL1xA9ldy3YrftcglDxGjJScAiEA78IHUnMa3SXxasZKeTh0o4qHQWAipBoF2czkOA8bQoYqoAMIvP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgw3NjU4OTI4OTY4MzYiDAb0ZItiQFL14WMwsCr0Ap0onfVYtfrZ1uthoY2hzr0tId%2BuzAqP1Jjg90LLfMAF0BP1fYI%2B%2FAeZuL7N2xGic57c02N7tLm9AFygefIp47BmdBxNaSrCpLqa792HiQCtQkupGxaAD%2Bxf9GxWo1Y0J4%2FVWpTQU3n4AhVXzEyJ4K5bXZVmLyzNbbb3qaGm17gqtRn%2BdRwDMZiyLNwHikIbXDPMAiiuGweDfuwLMxpbDG9LUuiI4g68gaFHJndU%2FEEtY71ZUa84%2B7tU9n%2FOsv03o248aZtebHVeib8Bm3qyxs02jK8Xs4yLxH6Fi1O8Ufic4HbLwup856I6%2FWjesf0iHqLmeAsEhtXdphC5HDKq7lPBL6qXInLupbffbHwm3ly3JsHDQGU5ydVlue664zYciBLaA2KRl8OYZIWaGPiLX3zIz0IcNRP0g0fXPxjIU%2BZsFi63kSvaIbgyx8JKEhJfE6QKZK25Vr8VnMYVdsXZuLeu9CY1WVQxGlNi8noz%2FQaQ7vHWlzDDzeqzBjqdAUOpfDlgFoB3xgy2Sg1PcUdP46tBDkDQRyXCi8LkIXHADR3l4d54qHVL5XDw9mabdusvidtxsH9%2B8kCodbVPLvnmExWX71zHTpqExN8TJ0a8pYPZhD%2Fusu7lrPmwqC0V7I01KRsnkhZ2J%2BzGKXUhglMAtuOeKdSirv6%2BJJM3MoCgJyKGZTyOPcs4nI%2BY4LpmlYAY9%2F8HbppHG2skDL4%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=ed1f5adef9220f06c2a15f0ecaa750da2044dc815cc782fb570d3dbb733f5aee",
        "filePath": "9i0FAHIDOM/user/7dNGUkKit2O/learning-record-attr/file/luke.pdf"",
        "fileName": "luke.pdf",
        "mimeType": "application/pdf",
        "size": 423377
      },
      "free-text": "waolom"
    }
  }
}
```

### Learning Record Updated

Example payload from Learning Record Updated webhooks, this Learning Record had a file updated.  When a custom attribute field is updated it shows as `attr` in `updatedFields`

```
{
  "user": {
    "id": "7dNGUkKit2O",
    "name": "Charlotte Blue",
    "email": "charlotte+blue@synap.ac",
    "subPortalId": "rtQY0MErP9S",
    "customAttributes": {
      "employee-id": null,
      "team": null,
      "quote": null,
      "dob": null,
      "last-certified-grade": null,
      "checker": null,
      "boxes": null
    }
  },
  "portal": {
    "id": "9i0FAHIDOM"
  },
  "meta": {
    "timestamp": "2024-06-25T11:16:31.398Z",
    "eventName": "learningRecord.updated"
  },
  "learningRecord": {
    "objectId": "lcfdxBQ13vT",
    "name": "The Smallest Record Who Ever Lived- Updated",
    "score": 66,
    "visibleToStudent": true,
    "achievedOn": "2024-06-24T23:00:00.000Z",
    "attr": {
      "grade": "a",
      "file": {
        "url": "https://synap-files-prod.s3.eu-west-1.amazonaws.com/9i0FAHIDOM/user/7dNGUkKit2O/learning-record-attr/file/vader.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA3EUWGFBCEAXPBNMS%2F20240625%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240625T113125Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEBQaCWV1LXdlc3QtMSJHMEUCIQCIZQ7TYH2JMLPp2TFCtv8wxZrmAKf6hlVg2n1w%2B8o%2B%2FgIgToHG%2Fpgr6OyIoLDdqRMi%2Fn8Et%2Blxh%2FLguyuBrjFFKtMqoAMIvf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARADGgw3NjU4OTI4OTY4MzYiDB6iLPq%2BzTXFj3v1lyr0AqpIU89mIl8inU80LYMA7pje0lmsS965Sd1JxC%2BgY9FoSdYHz%2FjxN9eLPU%2BzDLdWaBr6qzJtzPOxGyQrSrzUB5dEoCsGLc242ckbT4U%2BbBzzM4MZjstMOUx5uREfHLQkqAzpbHBtMqEAAjZ5LmZhzvMkBtO0EJcxvgh%2F5QQmpU6sg5Sfmic7xHAAun9KBTDPsAOcPmafK%2FwMyNexWqYRt7oMkTwjfznfzKjM4eBBzgOEHvhYVr4WGzqYpo1mDBtaFSRf5AKTthQDB%2FVibB1fmrV%2Fx9T9o2IJQJPUH1U06yBQ3UhtgxlXzYVExyDB1sgrhs8tmiycw6Q5pJBLHMfIplOsTsI8dSFQBZptywY2zzTeWQnYqC1JGu0nU7krr2kX20Y5XQEaFncvb%2Bwa3GUOMa0DP7%2B3nZk6Zs31JcB6%2FjMu8j%2FfsCN%2FYEwN%2B%2F4owQPfKZOitaY0O4XgHJRbV14g88jbUWPZTrcxYhHT%2FTb09uwOZzt0eDDw0uqzBjqdAYzwuoYP1pGbxlkpNz%2FdVPyv8317HiV13L0qoHsDBl9MDGuCR7HEPWPVfThY6v%2BbLh1d6YyhFLyO%2BXezYxKtW%2FAifKhh%2FDud4HK%2BCJqZsTtru8ffoKtmLTJbZFIfTyM5W8pPTeItTbQlfJCCqRvHyVam0Cis5bM8K%2BwEEIbU5xb40G2kcPsuBZEz3mzZsm1ITp0kYqX2IZhH1bHxKSE%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=a18b4ccebc5cd57f491c8a9cdca22b63465c0026462f911e19a7b9a715cc6887",
        "filePath": "9i0FAHIDOM/user/7dNGUkKit2O/learning-record-attr/file/vader.pdf",
        "fileName": "WU7BRiKFgZg.pdf",
        "mimeType": "application/pdf",
        "size": 423377
      },
      "free-text": "waolom?\nwysb wysb wysb"
    }
  },
  "updatedFields": [
    "attr",
    "achievedOn",
    "name",
    "score",
    "file"
  ]
}
```

### Learning Record Deleted

Example payload from Learning Record Updated webhooks

```
{
  "user": {
    "id": "7dNGUkKit2O",
    "name": "Charlotte Blue",
    "email": "charlotte+blue@synap.ac",
    "subPortalId": "rtQY0MErP9S",
    "customAttributes": {
      "employee-id": null,
      "team": null,
      "quote": null,
      "dob": null,
      "last-certified-grade": null,
      "checker": null,
      "boxes": null
    }
  },
  "portal": {
    "id": "9i0FAHIDOM"
  },
  "meta": {
    "timestamp": "2024-06-25T11:16:54.568Z",
    "eventName": "learningRecord.deleted"
  },
  "learningRecord": {
    "objectId": "lcfdxBQ13vT",
    "name": "The Smallest Record Who Ever Lived- Updated"
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/integrations/webhooks/learning-record-webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.