Update Webhook Endpoint

Update an endpoint’s URL, description, events, or status

PATCH /v1/webhooks/{id}

Update Webhook Endpoint

cURL

curl --request PATCH \
  --url https://api.signa.so/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": {},
  "enabled_events": [
    "<string>"
  ],
  "status": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.signa.so/v1/webhooks/{id}"

payload = {
    "url": "<string>",
    "description": {},
    "enabled_events": ["<string>"],
    "status": "<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>',
    description: {},
    enabled_events: ['<string>'],
    status: '<string>',
    metadata: {}
  })
};

fetch('https://api.signa.so/v1/webhooks/{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.signa.so/v1/webhooks/{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>',
    'description' => [
        
    ],
    'enabled_events' => [
        '<string>'
    ],
    'status' => '<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.signa.so/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"description\": {},\n  \"enabled_events\": [\n    \"<string>\"\n  ],\n  \"status\": \"<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.signa.so/v1/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"description\": {},\n  \"enabled_events\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.signa.so/v1/webhooks/{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  \"description\": {},\n  \"enabled_events\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "id": "whk_2mR8vNkT",
  "object": "webhook_endpoint",
  "url": "https://hooks.auroradigital.example.com/signa",
  "description": "Production alerts for Aurora Digital",
  "enabled_events": ["alert.created"],
  "status": "active",
  "secret_version": 1,
  "consecutive_failures": 0,
  "last_success_at": "2026-07-05T09:12:31.000Z",
  "last_failure_at": "2026-07-06T02:00:00.000Z",
  "metadata": {},
  "created_at": "2026-07-06T08:00:00.000Z",
  "updated_at": "2026-07-06T09:15:00.000Z",
  "request_id": "req_8mQ2vXpL"
}

Overview

Partial update: omitted fields are unchanged. Requires the portfolios:manage scope.

Path Parameters

id · string · required

Endpoint ID (whk_*).

Body Parameters

All fields optional.

url · string

New URL (HTTPS in production).

description · string | null

Description, or null to clear it.

enabled_events · string[]

Replace the enabled-events list.

status · string

active or disabled. Re-enabling an endpoint that was auto-disabled after repeated delivery failures resets consecutive_failures to 0.

metadata · object

Free-form metadata.

Response

The updated Webhook (secret redacted).

Errors

Status	type	When
400	validation_error	Invalid URL, unknown event type in enabled_events, or an unsupported status value
404	not_found	Endpoint doesn’t exist or belongs to another org

Code Examples

cURL

curl -X PATCH "https://api.signa.so/v1/webhooks/whk_2mR8vNkT" \
  -H "Authorization: Bearer sig_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: reenable-whk-2mR8vNkT-2026-06-12" \
  -d '{ "status": "active" }'

import { Signa } from "@signa-so/sdk";
const signa = new Signa({ api_key: process.env.SIGNA_API_KEY });

await signa.webhooks.update("whk_2mR8vNkT", { status: "active" });

{
  "id": "whk_2mR8vNkT",
  "object": "webhook_endpoint",
  "url": "https://hooks.auroradigital.example.com/signa",
  "description": "Production alerts for Aurora Digital",
  "enabled_events": ["alert.created"],
  "status": "active",
  "secret_version": 1,
  "consecutive_failures": 0,
  "last_success_at": "2026-07-05T09:12:31.000Z",
  "last_failure_at": "2026-07-06T02:00:00.000Z",
  "metadata": {},
  "created_at": "2026-07-06T08:00:00.000Z",
  "updated_at": "2026-07-06T09:15:00.000Z",
  "request_id": "req_8mQ2vXpL"
}

Related Endpoints

• Retrieve Webhook Endpoint - check current status and failure counts
• Test Webhook Endpoint - confirm an endpoint works after re-enabling it