StatusSupportGet API keyDashboard
WebhooksRegister a webhook endpoint

Webhooks

Register a webhook endpoint

Use with AI

POST /v1/webhook_endpoints

Registers an https URL to receive the events it subscribes to, signed per Standard Webhooks. The answer is the only time secret is shown: store it to verify signatures. At most max_endpoints (16) per account and mode. Free.

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

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://socialtap.dev/v1/webhook_endpoints' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "events": [
    "string"
  ],
  "url": "string"
}'

Authorizations

x-api-keystringheaderrequired

Your API key, with the admin scope. Authentication

Headers

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.

Body

application/json

JSON. Fields marked nullable may be null; optional ones may be left out.

description?stringnullable
eventsstring[]

Event types, prefix wildcards (job.*) or *.

urlstring

An https URL on a public host (no IP addresses of private, loopback or link-local networks; redirects are not followed).

Response

application/json

201

Register a webhook endpoint

dataobject
ShowHide 12 child fields
created_atstring date-time
created_by_userstringnullable

The person (GET /v1/members user_id) who created this endpoint in the dashboard, or whose API key created it. They may have left the account since. Null when no person did, or it is from before this was recorded.

descriptionstringnullable
disabled_reasonstringnullable

Why it is disabled: gone (it answered 410), failing (deliveries failed for 5 days), user. Null while enabled.

One ofgonefailinguser

eventsstring[]

Event types it receives: types, prefix wildcards (job.*) or * for all.

idstring

we_…

objectstring

Always webhook_endpoint.

One ofwebhook_endpoint

previous_secret_expires_atstring date-timenullable

Until then the previous secret signs too; null when none.

secret?stringnullable

The signing secret (whsec_…): only in the create and rotate_secret answers. Store it.

statusstring

One ofenableddisabled

updated_atstring date-time
urlstring

https URL deliveries are POSTed to. A key an agent collected from an approval reads only its host: https://host/.

metaobject

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

400

400 Bad Request.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too 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, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

409

409 Conflict.

idempotency_key_in_progressYes, later

A request with this Idempotency-Key is still running.

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

422

422 Unprocessable.

idempotency_key_reusedNo retry

This Idempotency-Key was already used for a different request (another route or body). Or it was used for this same request, which ran and returned a secret we no longer keep (details.reason answer_expired): running it again would create another.

Use a new Idempotency-Key for a different request, and reuse a key only to retry the identical request. With reason answer_expired, check what the first request created (GET /v1/api_keys, GET /v1/webhook_endpoints) before sending it again under a new key.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId webhook_endpoints.create