v10

latestOpenAPI 3.1.02026-08-0452108384.4 KB

Webhooks

Test Webhook Url

Send a test event to verify connectivity and payload handling. Either provide a webhook_id to test an existing webhook (with optional url/secret overrides), or provide url and event_type directly to test before creating a webhook.

post/v0/webhooks/test

Request body

webhook_idinteger nullable

ID of an existing webhook to test. When provided, url and event_type are loaded from the stored webhook. Body fields (url, secret) can override stored values.

urlstring uri nullable

URL to send the test event to. Required when webhook_id is not provided.

event_type'job_new' | 'company_new' | 'job_closed'

secretstring nullable

Secret used to sign webhook payloads with HMAC-SHA256. If set, deliveries include an X-TheirStack-Signature-256 header.

Example request

{
  "url": "https://example.com/webhook"
}

Response

Successful Response

statusinteger required

messagestring nullable

signaturestring nullable