Skip to main content
PATCH
/
webhooks
/
{webhook_id}
Update Webhook
curl --request PATCH \
  --url https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/signing-request-api/webhooks/{webhook_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "enabled": true,
  "events": [
    "signing_request.created"
  ],
  "description": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companies_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "enabled": true,
  "events": [
    "signing_request.created"
  ],
  "description": "<string>",
  "consecutive_failures": 123,
  "last_failure_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: 'Bearer your-api-key'

Path Parameters

​
webhook_id
string<uuid>
required

Body

application/json
​
url
string<uri>
Maximum length: 2048
​
enabled
boolean

Enable or disable webhook

​
events
enum<string>[]
​
description
string
Maximum length: 500

Response

Webhook updated successfully

​
id
string<uuid>
required

Unique webhook identifier

​
companies_id
string<uuid>
required

Company ID this webhook belongs to

​
url
string<uri>
required

Destination URL for webhook events

Maximum length: 2048
​
enabled
boolean
required

Whether the webhook is active

​
events
enum<string>[]
required

List of event types this webhook subscribes to

​
description
string

Optional description of webhook purpose

Maximum length: 500
​
consecutive_failures
integer

Number of consecutive delivery failures

​
last_failure_at
string<date-time>

Timestamp of last delivery failure

​
created_at
string<date-time>
​
updated_at
string<date-time>