Webhooks

Register a new webhook endpoint

Returns the endpoint metadata + a one-time signingSecret. Store the secret immediately; subsequent reads do not include it. Free tier allows 1 endpoint, Pro 10, Org 100; the cap returns 402 with an upgrade_required payload.

post/webhooks

Request

  • Base URL: https://thesignup.app/api/v1
  • URL: https://thesignup.app/api/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

HTTPS URL the platform will POST to. Plain HTTP is rejected.

descriptionstring
eventTypesstring[]

Optional subscription filter. Omit or pass an empty array to subscribe to every event type.

Example request

{
  "url": "https://hooks.example.com/thesignup"
}

Response

Endpoint registered

signingSecretstring required

Plaintext signing secret. Surfaced exactly once — store it immediately. Subsequent reads only return the endpoint metadata; rotate via POST /v1/webhooks/{id}/rotate.

Example response

{
  "signingSecret": "whsec_AbCdEf..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.