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>",
  "api_version": "<string>",
  "metadata": {}
}
'
import requests

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

payload = {
"url": "<string>",
"enabled_events": ["<string>"],
"events": ["<string>"],
"description": "<string>",
"api_version": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
enabled_events: ['<string>'],
events: ['<string>'],
description: '<string>',
api_version: '<string>',
metadata: {}
})
};

fetch('https://api.arcuserp.com/v1/webhook_endpoints/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'enabled_events' => [
'<string>'
],
'events' => [
'<string>'
],
'description' => '<string>',
'api_version' => '<string>',
'metadata' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

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

payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"api_version\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.arcuserp.com/v1/webhook_endpoints/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"api_version\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"enabled_events\": [\n \"<string>\"\n ],\n \"events\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"api_version\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "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": {}
}
{
"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"
}
{
"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.

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.