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
TheirStack TheirStack Logo
DocumentationAPI ReferenceWebhooksDatasets
Webhooks

Test Webhook Url

This endpoint is used to test the webhook before creating it. It will send a test event to the webhook URL.

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 the webhook events. This endpoint is used to retry the webhook events if they failed.

Create New Webhook POST

Create a new webhook to listen to events from a saved search