Webhook endpoints

Update a webhook endpoint

Update a webhook endpoint URL or status.

PATCH/v1/webhook-endpoints/{id}
0credits
x-api-keystringheader

API key (`sfk_...`)

Parameters
1
idstringrequiredpath

Webhook endpoint identifier.

min 1 chars

Request body

requiredapplication/json
Response fields
15

Endpoint-specific response payload.

dataid
string

Stable identifier for the webhook endpoint.

min 1 chars

datakind
string

Delivery kind: `http` posts events to a customer-supplied URL; `sink` is a hosted test inbox with no URL (limited per account).

one of: http, sink

dataurl
stringnullable

Destination URL, or `null` for `sink` endpoints.

datadescription
stringnullable

Human-readable label, when set.

datastatus
string

Endpoint lifecycle status. `disabled` is set automatically after sustained delivery failures; `disabled_by_user` is set by the caller.

one of: active, disabled, disabled_by_user

dataconsecutiveFailures
integer

Consecutive delivery failures since the last success.

≥ 0

datafailingSince
stringnullable

ISO-8601 timestamp of the start of the current failure streak, or `null` when healthy.

datacreatedAt
string

ISO-8601 timestamp for when the endpoint was created.

dataupdatedAt
string

ISO-8601 timestamp for when the endpoint was last updated.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

metacached
booleanoptional

True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.

Code example

curl "https://api.socialfetch.dev/v1/webhook-endpoints/abc123" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"string","status":"active"}' \
  -X PATCH

Responses

Updated webhook endpoint.