List webhook endpoints for the entity

Returns a cursor-paginated list of outbound webhook endpoint subscriptions registered for the authenticated entity. Each record includes the endpoint URL, enabled_events subscription list, delivery statistics, and operational status.

Requires webhooks:manage scope.

GET /webhook_endpoints

List webhook endpoints for the entity

cURL

curl --request GET \
  --url https://api.arcuserp.com/v1/webhook_endpoints \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/webhook_endpoints"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/webhook_endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/webhook_endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/webhook_endpoints"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/webhook_endpoints")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/webhook_endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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>",
      "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"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

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

200

application/json

Paginated list of webhook endpoint records

object · enum<string>

Available options: list

data · object[]

Show child attributes

has_more · boolean

next_cursor · string<uuid> | null