Skip to content

Pull events (cursor-based)

GET
/v1/pull/{endpoint}

For consumers behind a firewall. Cursor-based, batch up to 100; advancing the cursor (or an explicit ack) commits. Availability window = the domain's retention setting.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Path Parameters

endpoint*
Type
string
Required

Query Parameters

cursor

Opaque pagination cursor; pass back next_cursor from the previous page.

Type
string
limit
Type
integer
Maximum
100
Default
50

Responses

A batch of events.

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "evt_01JX9",
  
  
  
"event_type": "orders/create",
  
  
  
"endpoint": "/shopify-store/orders",
  
  
  
"status": "string",
  
  
  
"received_at": "string",
  
  
  
"attempts": [
  
  
  
  
{
  
  
  
  
  
"number": 1,
  
  
  
  
  
"status": 200,
  
  
  
  
  
"duration_ms": 142,
  
  
  
  
  
"at": "string",
  
  
  
  
  
"response_excerpt": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"next_cursor": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Apache-2.0 licensed · a Finnoto product