Skip to main content
cURL
Cost: Free.
Needs the webhooks:write scope. The secret is never shown again after creation: if you lost it, rotate it. A disabled endpoint’s disabled_reason is manual (you disabled it) or failing (Alura disabled it after its deliveries kept failing).

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The webhook endpoint ID (we_...).

Required string length: 1 - 64
Example:

"we_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: "webhook_endpoint"
id
string
required

we_...

url
string
required

Where events are sent: an HTTPS URL.

description
string | null
required

Your note for this endpoint; null when none was set.

event_types
string[]
required

Etsy's event types this endpoint receives: * for every type, an exact type such as order.paid, or a prefix such as order.*.

shop_ids
string[] | null
required

Only events of these connected shops; null for every connected shop of the workspace, including shops connected later.

status
enum<string>
required

enabled receives events; disabled receives none until enabled again.

Available options:
enabled,
disabled
disabled_reason
enum<string> | null
required

Why a disabled endpoint is disabled: manual (PATCH) or failing (deliveries kept failing). Null while enabled.

Available options:
manual,
failing
created_at
string
required

When the endpoint was created (ISO 8601, UTC).