Skip to main content
PATCH
/
v1
/
webhook-endpoints
/
{id}
Update a webhook endpoint
curl --request PATCH \
  --url https://api.scrip.dev/v1/webhook-endpoints/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "Updated webhook receiver",
  "enabled_events": [
    "*"
  ],
  "metadata": "<unknown>",
  "status": "DISABLED",
  "url": "https://new-url.example.com/webhooks"
}
'
import requests

url = "https://api.scrip.dev/v1/webhook-endpoints/{id}"

payload = {
    "description": "Updated webhook receiver",
    "enabled_events": ["*"],
    "metadata": "<unknown>",
    "status": "DISABLED",
    "url": "https://new-url.example.com/webhooks"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Updated webhook receiver',
    enabled_events: ['*'],
    metadata: '<unknown>',
    status: 'DISABLED',
    url: 'https://new-url.example.com/webhooks'
  })
};

fetch('https://api.scrip.dev/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.scrip.dev/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([
    'description' => 'Updated webhook receiver',
    'enabled_events' => [
        '*'
    ],
    'metadata' => '<unknown>',
    'status' => 'DISABLED',
    'url' => 'https://new-url.example.com/webhooks'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.scrip.dev/v1/webhook-endpoints/{id}"

	payload := strings.NewReader("{\n  \"description\": \"Updated webhook receiver\",\n  \"enabled_events\": [\n    \"*\"\n  ],\n  \"metadata\": \"<unknown>\",\n  \"status\": \"DISABLED\",\n  \"url\": \"https://new-url.example.com/webhooks\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.scrip.dev/v1/webhook-endpoints/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Updated webhook receiver\",\n  \"enabled_events\": [\n    \"*\"\n  ],\n  \"metadata\": \"<unknown>\",\n  \"status\": \"DISABLED\",\n  \"url\": \"https://new-url.example.com/webhooks\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/webhook-endpoints/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Updated webhook receiver\",\n  \"enabled_events\": [\n    \"*\"\n  ],\n  \"metadata\": \"<unknown>\",\n  \"status\": \"DISABLED\",\n  \"url\": \"https://new-url.example.com/webhooks\"\n}"

response = http.request(request)
puts response.read_body
{
  "circuit_broken_until": "2026-01-15T10:40:00Z",
  "created_at": "2026-01-15T10:30:00Z",
  "description": "Production webhook receiver",
  "enabled_events": [
    "balance.credited",
    "balance.debited"
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": "<unknown>",
  "rate_limited_until": "2026-01-15T10:35:00Z",
  "secret": "whsec_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "status": "ACTIVE",
  "updated_at": "2026-01-15T10:30:00Z",
  "url": "https://example.com/webhooks"
}
{
  "code": "bad_request",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Invalid request parameters"
}
{
  "code": "unauthorized",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Missing or invalid credentials"
}
{
  "code": "forbidden",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Insufficient permissions for this action"
}
{
  "code": "not_found",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Resource not found"
}
{
  "code": "unsupported_media_type",
  "details": {
    "expected": "uuid",
    "field": "asset_id",
    "fields": [
      {
        "expected": "<unknown>",
        "field": "amount",
        "message": "This field is required",
        "reason": "required",
        "received": "-10.00"
      }
    ],
    "reason": "invalid",
    "received": "not-a-uuid"
  },
  "message": "Content-Type must be application/json"
}
{
  "code": "internal_error",
  "message": "An internal error occurred"
}
Partially updates a webhook endpoint. Only the fields you include in the request body are changed; omitted fields are preserved. You can update the url, description, enabled_events, status (ACTIVE or DISABLED), and metadata. To rotate the signing secret, use the rotate secret endpoint instead. Setting status to DISABLED immediately fails queued or in-flight deliveries for the endpoint with error_code: "endpoint_disabled". Set it back to ACTIVE to receive future matching events.
For usage patterns and examples, see the Webhooks guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
id
string<uuid>
required

Endpoint ID

Body

application/json

Fields to update

​
description
string

Updated description

Example:

"Updated webhook receiver"

​
enabled_events
string[]

Replace the event type subscription list

Example:
["*"]
​
metadata
any

Replace metadata

​
status
string

Set to ACTIVE or DISABLED

Example:

"DISABLED"

​
url
string

New HTTPS URL for deliveries

Example:

"https://new-url.example.com/webhooks"

Response

Updated endpoint

​
circuit_broken_until
string

When set and in the future, the circuit breaker has paused deliveries to this endpoint until this time (sustained delivery failures)

Example:

"2026-01-15T10:40:00Z"

​
created_at
string<date-time>

When the endpoint was created

Example:

"2026-01-15T10:30:00Z"

​
description
string

Human-readable label

Example:

"Production webhook receiver"

​
enabled_events
string[]

Subscribed event types

Example:
["balance.credited", "balance.debited"]
​
id
string<uuid>

Endpoint ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
metadata
any

Arbitrary metadata

​
rate_limited_until
string

When set and in the future, 429 rate-limit backoff has paused deliveries to this endpoint until this time

Example:

"2026-01-15T10:35:00Z"

​
secret
string

Signing secret (only returned on create and rotate — store it immediately)

Example:

"whsec_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"

​
status
string

Lifecycle status: ACTIVE, DISABLED, or ARCHIVED

Example:

"ACTIVE"

​
updated_at
string<date-time>

When the endpoint was last modified

Example:

"2026-01-15T10:30:00Z"

​
url
string

Destination URL for deliveries

Example:

"https://example.com/webhooks"