Webhook endpoints

Send a test webhook event

Send a signed test event to a webhook endpoint.

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

API key (`sfk_...`)

Parameters
1
idstringrequiredpath

Webhook endpoint id.

min 1 chars

Request body

application/json
Response fields
10

Endpoint-specific response payload.

datastatus
string

Outcome of the test delivery attempt.

one of: success, failed

dataresponseStatus
integernullable

HTTP status code returned by the endpoint, when available.

dataresponseBodySnippet
stringnullable

Truncated response body from the endpoint, when available.

datadurationMs
integer

Duration of the delivery attempt in milliseconds.

≥ 0

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

Responses

Result of the synchronous test delivery attempt.