Skip to main content
cURL
Cost: Free.
Needs the webhooks:write scope. The fields take the same values as in Create webhook. shop_ids: null means every connected shop.

Pause or resume an endpoint

"status": "disabled" stops storing and sending events for the endpoint, and cancels the retries still queued for it. "status": "enabled" starts again from now on. Events missed while it was disabled are not replayed. An endpoint Alura disabled for failing (disabled_reason: "failing") stays disabled until you fix it and set status back to enabled.

Change filters

Deliveries still queued that the new event types or shops no longer want are cancelled, with error: "endpoint_changed" in List deliveries.
On an endpoint with order event types, or with order events still queued for it, these need the orders:read scope as well: changing its URL, event types or shops, and enabling it. Disabling it doesn’t.
Send an Idempotency-Key to retry safely. See Idempotency.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Makes a retry safe: the same key with the same request within 24 hours returns the first result (with Idempotent-Replayed: true) instead of writing again. The same key with a different request is a 409 conflict; while the first request still runs, 409 idempotency_processing.

Required string length: 1 - 255

Path Parameters

id
string
required

The webhook endpoint ID (we_...).

Required string length: 1 - 64
Example:

"we_01JMOCK0000000000000000000"

Body

application/json
url
string

The HTTPS URL Alura sends events to: a public host.

Maximum string length: 2048
event_types
string[]

Event types to receive: * for every type, an exact type such as order.paid, or a prefix such as order.*. Order events need the orders:read scope too.

Required array length: 1 - 20 elements
Maximum string length: 200
Pattern: ^(\*|[A-Za-z0-9_-]+(\.[A-Za-z0-9_-]+)*(\.\*)?)$
shop_ids
string[] | null

Only events of these connected shops (Etsy shop IDs). Leave out or null for every connected shop, including shops connected later. A shop that isn't connected to the workspace is 404.

Required array length: 1 - 100 elements
Pattern: ^[1-9]\d{0,18}$
description
string | null

A note for yourself, up to 500 characters.

Maximum string length: 500
status
enum<string>

disabled stops storing and sending events for this endpoint; enabled starts again from now on. Events missed while disabled are not replayed.

Available options:
enabled,
disabled

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).