Skip to main content
PATCH
/
webhook_endpoints
/
{id}
Update a webhook endpoint
curl --request PATCH \
  --url https://api.arcuserp.com/v1/webhook_endpoints/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "enabled_events": [
    "<string>"
  ],
  "events": [
    "<string>"
  ],
  "description": "<string>",
  "status": "active",
  "api_version": "<string>",
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "webhook_endpoint",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "description": "<string>",
  "enabled_events": [
    "order.confirmed",
    "payment.succeeded",
    "fulfillment.shipped"
  ],
  "secret_last4": "<string>",
  "status": "active",
  "mode": "live",
  "api_version": "<string>",
  "success_count": 123,
  "failure_count": 123,
  "consecutive_failure_count": 123,
  "last_delivery_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

​
id
string<uuid>
required

Webhook endpoint ID.

Body

application/json
​
url
string<uri>
​
enabled_events
string[]

Replace the subscription list. Must be non-empty if provided.

​
events
string[]

Deprecated. Use enabled_events. Accepted for back-compat; removed in v2.

​
description
string | null
​
status
enum<string>
Available options:
active,
paused,
disabled
​
api_version
string | null
​
metadata
object

Response

Updated webhook endpoint record

An outbound webhook endpoint subscription. Arcus delivers signed JSON payloads to the url whenever a subscribed event fires.

Field names: the subscription list is enabled_events (Stripe convention). The deprecated alias events is accepted in request bodies for back-compat and will be removed in v2.

​
id
string<uuid>
​
object
enum<string>
Available options:
webhook_endpoint
​
entity_id
string<uuid>
​
url
string<uri>

HTTPS endpoint receiving events.

​
description
string | null
​
enabled_events
string[]

Event types this endpoint subscribes to. Wildcards supported: * (all 118 events) or <family>.* (e.g. order.*).

Example:
[
  "order.confirmed",
  "payment.succeeded",
  "fulfillment.shipped"
]
​
secret_last4
string | null

Last 4 hex chars of the signing secret (for identification only).

​
status
enum<string>

active receives events; paused skips delivery (retains subscription); disabled is permanently off.

Available options:
active,
paused,
disabled
​
mode
enum<string>

live endpoints receive production events; test endpoints receive test-mode events only.

Available options:
live,
test
​
api_version
string | null
​
success_count
integer

Total successful deliveries (HTTP 2xx).

​
failure_count
integer

Total failed deliveries (non-2xx or timeout).

​
consecutive_failure_count
integer

Consecutive failures since last success. 5+ consecutive failures auto-pauses the endpoint.

​
last_delivery_at
string<date-time> | null
​
created_at
string<date-time>
​
metadata
object

Arbitrary key-value pairs stored by the creator.