IntroductionQuickstartAuthenticationPaginationRate Limit

Search endpoints

Job Search POSTCompany Search POSTTechnographics POST

Account endpoints

Get Credit Balance GETGet Credits Consumption GET

Other

Get Webhook By Id GETGet Aggregated Webhook Event Count GETGet Webhook Event Count GETList Webhook Events GETList All Webhooks GETArchive Webhook PATCHUpdate Webhook PATCHEnable/Disable A Webhook PATCHRetry Webhook Events POSTTest Webhook Url POSTCreate New Webhook POST
TheirStackTheirStack Logo
Log inSign up
DocumentationAPI ReferenceWebhooksDatasetsMCPGuides
Webhooks

Test Webhook Url

Send a test event to a webhook URL to verify connectivity and payload handling before creating the webhook. The test event simulates a real webhook delivery so you can validate your endpoint processes events correctly.

POST
/v0/webhooks/test

Authorization

Bearer
AuthorizationBearer <token>

In: header

Request Body

application/json

  • url
    string
    length: 1 <= length <= 2083uri
    required
  • event_type
    stringrequired
    • job_new
    • company_new

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.theirstack.com/v0/webhooks/test" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "event_type": "job_new"  }'
{
  "status": 0,
  "message": "string"
}
{
  "request_id": null,
  "error": {
    "code": "E-001",
    "title": "Not allowed exception",
    "description": "string"
  }
}
{
  "request_id": null,
  "error": {
    "code": "E-001",
    "title": "Not allowed exception",
    "description": "string"
  }
}
{
  "request_id": null,
  "error": {
    "code": "E-001",
    "title": "Not allowed exception",
    "description": "string"
  }
}
{
  "request_id": null,
  "error": {
    "code": "E-001",
    "title": "Not allowed exception",
    "description": "string"
  }
}

How is this guide?

Last updated on

Retry Webhook Events POST

Retry delivery of failed webhook events by providing their event IDs. Use this endpoint to recover from transient failures such as network timeouts or temporary server errors on your receiving endpoint.

Create New Webhook POST

Create a new webhook that listens for events from a saved search and sends real-time HTTP POST notifications to your specified URL. Configure event types, filters, and delivery settings for automated data pipelines.