Webhook endpoints

Create a webhook endpoint

Create a webhook endpoint to receive signed monitor deliveries.

POST/v1/webhook-endpoints
0credits
x-api-keystringheader

API key (`sfk_...`)

Request body

requiredapplication/json
Response fields
11

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.

datasecret
string

Signing secret for verifying webhook deliveries. Shown ONLY in this response — store it now, it cannot be retrieved again.

min 1 chars

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" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"http","url":"string","description":"string"}' \
  -X POST

Responses

Webhook endpoint created. `secret` is returned here only — it cannot be retrieved again.