Skip to main content
cURL
Cost: Free.
Needs the events:read scope. Order events need orders:read as well; without it they’re left out. An event exists only if a webhook endpoint of the workspace was enabled and wanted it: events from before the first endpoint, or for types and shops no endpoint wanted, were never stored. Events are kept 30 days. Use the list to catch up on events your endpoint didn’t receive. data is Etsy’s payload exactly as Etsy sent it: today event_type, resource_url and shop_id. Calling resource_url needs an Etsy app of your own. Read the same data from Alura instead: for an order.* event, use Get order with the receipt ID at the end of resource_url.

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

type
string

Only events of this type (order.paid) or prefix (order.*).

Maximum string length: 200
Pattern: ^(\*|[A-Za-z0-9_-]+(\.[A-Za-z0-9_-]+)*(\.\*)?)$
shop_id
string

Only events of this connected shop.

Pattern: ^[1-9]\d{0,18}$
created_after

Only events received after this moment: an ISO 8601 date or date-time. Events older than 30 days are gone.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required