Send a webhook.test event to an endpoint · SocialTap API reference

Emits a webhook.test event delivered to this endpoint only (signed and retried like any event). The answer is the event; its delivery appears in the endpoint's deliveries. Free.

Auth: an API key with the admin scope, or the dashboard session.

Test mode: A test key manages the account's test webhook endpoints, separate from live ones; they receive test events only (a test job's job.* events and webhook.test), signed and retried like live ones.

Send an idempotency-key header to retry safely: the same key and body within 1 day never repeat the work.

Example

cURL

curl -X POST 'https://staging.socialtap.dev/v1/webhook_endpoints/<id>/test' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

x-api-keystringheaderrequired

Your API key, with the admin scope. Authentication

Path parameters

Name	Type	Description	Example
`id` required	`string`	Webhook endpoint ID (we_…).	—

idstringrequired

Webhook endpoint ID (we_…).

Headers

Name	Type	Description	Example
`idempotency-key` optional	`string` max 255 chars	On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state.	—

idempotency-keystringmax 255 chars

On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state.

Response

application/json

200

Send a webhook.test event to an endpoint

Field	Type	Description
`data`	`object`
`data.data`	`any`	The type's data object (small: a summary plus links).
`data.id`	`string`	The event ID (evt_…): the webhook-id header of every delivery, the same on retries. Deduplicate on it.
`data.object`	`string`	Always event. One of `event`
`data.timestamp`	`string` (date-time)	When it happened.
`data.type`	`string`	The event type (event types table); new types may be added.
`meta`	`object`	The shared route meta (see the API reference introduction).

dataobject

Show 5 child fields

dataany

The type's data object (small: a summary plus links).

idstring

The event ID (evt_…): the webhook-id header of every delivery, the same on retries. Deduplicate on it.

objectstring

Always event.

One ofevent

timestampstring date-time

When it happened.

typestring

The event type (event types table); new types may be added.

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

Code	HTTP	Retry	Meaning	What to do
`invalid_input`	400	No	The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.	Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

invalid_inputNo retry

The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.

Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

401

401 Unauthorized.

Code	HTTP	Retry	Meaning	What to do
`unauthorized`	401	No	The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).	Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

unauthorizedNo retry

The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).

Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

403

403 Forbidden.

Code	HTTP	Retry	Meaning	What to do
`forbidden`	403	No	The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.	Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP.

forbiddenNo retry

The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.

Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP.

404

404 Not Found.

Code	HTTP	Retry	Meaning	What to do
`not_found`	404	No	The item does not exist or was deleted.	Check the URL or ID; do not retry.

not_foundNo retry

The item does not exist or was deleted.

Check the URL or ID; do not retry.

409

409 Conflict.

Code	HTTP	Retry	Meaning	What to do
`idempotency_key_in_progress`	409	Yes, later	A request with this Idempotency-Key is still running.	Retry after the number of seconds in the retry-after header to get that request's result.

idempotency_key_in_progressYes, later

A request with this Idempotency-Key is still running.

Retry after the number of seconds in the retry-after header to get that request's result.

422

422 Unprocessable.

Code	HTTP	Retry	Meaning	What to do
`idempotency_key_reused`	422	No	The Idempotency-Key was already used with a different request (another route, or another body).	Send a new Idempotency-Key for a different request; reuse a key only to retry the identical request.

idempotency_key_reusedNo retry

The Idempotency-Key was already used with a different request (another route, or another body).

Send a new Idempotency-Key for a different request; reuse a key only to retry the identical request.

429

429 Too Many Requests.

Code	HTTP	Retry	Meaning	What to do
`rate_limited`	429	Yes, later	The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.	Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

rate_limitedYes, later

The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.

Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

Test mode

A test key manages the account's test webhook endpoints, separate from live ones; they receive test events only (a test job's job.* events and webhook.test), signed and retried like live ones.

operationId webhook_endpoints.test