Skip to main content
GET
/
webhook_endpoints
List webhook endpoints for the entity
curl --request GET \
  --url https://api.arcuserp.com/v1/webhook_endpoints \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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": {}
    }
  ],
  "has_more": true,
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 100
​
starting_after
string<uuid>

Cursor for pagination -- return records created before this ID.

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

Response

Paginated list of webhook endpoint records

​
object
enum<string>
Available options:
list
​
data
object[]
​
has_more
boolean
​
next_cursor
string<uuid> | null