query · Module: Events
Arguments
Returns
Event!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query Event($id: ID!) {
event(id: $id) {
id
object
type
livemode
created
api_version
account
request {
id
idempotency_key
}
pending_webhooks
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"event": {
"id": "obj_1a2B3c",
"object": "event",
"type": "example",
"livemode": true,
"created": 1791302400,
"api_version": "example",
"account": "acct_ada",
"request": {
"id": "obj_1a2B3c",
"idempotency_key": "example"
},
"pending_webhooks": 2
}
}
}
Retrieve an event
query Event($id: ID!) {
event(id: $id) {
id
object
type
livemode
created
api_version
account
request {
id
idempotency_key
}
pending_webhooks
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"event": {
"id": "obj_1a2B3c",
"object": "event",
"type": "example",
"livemode": true,
"created": 1791302400,
"api_version": "example",
"account": "acct_ada",
"request": {
"id": "obj_1a2B3c",
"idempotency_key": "example"
},
"pending_webhooks": 2
}
}
}
query · Module: Events
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
Event!
| Field | Type |
|---|---|
id | String! |
object | EventObject! |
livemode | Boolean |
created | Int! |
type | String! |
api_version | String |
account | String |
data | EventData! |
related | JSON |
request | EventRequest |
pending_webhooks | Int |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Event($id: ID!) {
event(id: $id) {
id
object
type
livemode
created
api_version
account
request {
id
idempotency_key
}
pending_webhooks
}
}
{
"id": "obj_1a2B3c"
}
{
"data": {
"event": {
"id": "obj_1a2B3c",
"object": "event",
"type": "example",
"livemode": true,
"created": 1791302400,
"api_version": "example",
"account": "acct_ada",
"request": {
"id": "obj_1a2B3c",
"idempotency_key": "example"
},
"pending_webhooks": 2
}
}
}