Skip to main content
cURL
Cost: Free.
Needs the events:read scope, and orders:read as well for an order event. The event’s ID is the webhook-id header of its deliveries, and the body is what a delivery sends. An event older than 30 days, or not in this workspace, answers 404 not_found. To read data, see List events.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The event ID (evt_...).

Required string length: 1 - 64
Example:

"evt_01JMOCK0000000000000000000"

Query Parameters

fields
string

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

Response

OK

object
string
required
Allowed value: "event"
id
string
required

evt_...

type
string
required

Etsy's event type, as Etsy sent it (for example order.paid).

created_at
string
required

When Alura received the event from Etsy.

shop_id
string
required

The Etsy shop the event is about: one of the workspace's connected shops.

data
object
required

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 matching /v1/workspace/* endpoint instead.