Register a webhook endpoint · SocialTap API reference

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.

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' \
  -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

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.

Body

application/json

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

Field	Type	Description
`description?`	`string` or `null`
`events`	`string[]`	Event types, prefix wildcards (job.) or .
`url`	`string`	An https URL on a public host (no IP addresses of private, loopback or link-local networks; redirects are not followed).

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

Field	Type	Description
`data`	`object`
`data.created_at`	`string` (date-time)
`data.description`	`string` or `null`
`data.disabled_reason`	`string` or `null`	Why it is disabled: gone (it answered 410), failing (deliveries failed for 5 days), user. Null while enabled. One of `gone`, `failing`, `user`
`data.events`	`string[]`	Event types it receives: types, prefix wildcards (job.) or for all.
`data.id`	`string`	we_…
`data.object`	`string`	Always webhook_endpoint. One of `webhook_endpoint`
`data.previous_secret_expires_at`	`string` (date-time) or `null`	Until then the previous secret signs too; null when none.
`data.secret?`	`string` or `null`	The signing secret (whsec_…): only in the create and rotate_secret answers. Store it.
`data.status`	`string`	One of `enabled`, `disabled`
`data.updated_at`	`string` (date-time)
`data.url`	`string`	https URL deliveries are POSTed to.
`meta`	`object`	The shared route meta (see the API reference introduction).

dataobject

Show 11 child fields

created_atstring date-time

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.

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.

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.create