pass.granted
EVENT pass.granted
An access pass is granted or extended
Trigger
A pass is granted (by hand, from the CSV import, the REST API or an extension) or extended. Not sent again for a retried grant with the same reference.
Payload fields
| Field | Type | Meaning |
|---|---|---|
grant_id |
integer |
|
user_id |
integer |
|
user_email |
string|null |
|
plan_id |
integer |
|
plan_title |
string |
|
source |
string |
manual, api, or ext: |
source_ref |
string|null |
The reference the pass was granted with (your order line). |
starts_at |
string |
UTC, as YYYY-MM-DD HH:MM:SS. |
expires_at |
string|null |
Null when it never ends. |
status |
string |
active, revoked or expired. |
extended |
boolean |
True when this pass.granted is an extension of an existing pass. |
Payload
{
"event": "pass.granted",
"timestamp": "2026-11-05T14:00:00+00:00",
"site": "https://your-site.example",
"data": {
"grant_id": 57,
"user_id": 412,
"user_email": "[email protected]",
"plan_id": 3,
"plan_title": "Reading Part A — 3 days",
"source": "api",
"source_ref": "order-1042-line-1",
"starts_at": "2026-11-05 14:00:00",
"expires_at": "2026-11-08 14:00:00",
"status": "active",
"extended": false
}
}
See also
- Webhook events — envelope, signing and delivery