For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference
    • Introduction
      • POSTCreate Grant Approval
      • POSTCreate Grant
      • GETRetrieve Grant
      • POSTRevoke Grant
      • POSTCreate Grant Alias
      • POSTStart Grant Link Flow
      • POSTGrant status updated
LogoLogo
ReferenceGrants

Grant status updated

Payload
1{
2  "type": "on_file_grant.status.updated",
3  "eventId": "87f5ded7-2747-4e31-95ee-8993e0ae8663",
4  "createdAt": "2025-08-22T19:34:37.497Z",
5  "data": {
6    "id": "001.lhhm7tim5rv7buhjuvplka7neiam9victmhs3dctj883gcggb8upmvqqeius9j6o",
7    "type": "ON_FILE_GRANT",
8    "object": {
9      "grant": {
10        "id": "001.lhhm7tim5rv7buhjuvplka7neiam9victmhs3dctj883gcggb8upmvqqeius9j6o",
11        "type": "ON_FILE",
12        "status": "CANCELLED",
13        "created": "2025-08-21T16:22:03.294Z",
14        "cancelled": "2025-08-22T19:34:35.012Z"
15      }
16    }
17  }
18}
Webhook notification sent when a grant's status changes
Was this page helpful?
Previous

Create Billing Agreement

Next
Built with

Payload

The payload of this webhook request is an object.
typestringRequired
eventIdstringRequiredformat: "uuid"
createdAtstringRequiredformat: "date-time"
dataobjectRequired

Response

200
Acknowledgment that the webhook was received