Update Webhook

Authorization

Bearer

AuthorizationBearer <token>

In: header

Path Parameters

webhook_id

integer

required

ID of the webhook

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active_event_types
array<WebhookEventType>nullable
Event types this webhook subscribes to. If None, defaults to the search type's primary event (job_new for jobs, company_new for companies).
- job_new
- company_new
- job_closed
description
stringnullable
Webhook for new jobs
Description of the webhook
listening_start_time
stringnullable
date-time2024-01-01T00:00:00Z
Date when the webhook started listening for events. If listening_start_time is None, the webhook will listen to all events matching the search query regardless of when they occurred.
max_events_per_day
integernullable
0 <= value500
Maximum number of events this webhook may send per day (UTC). The cap is applied when events are created, so events above it are never sent and never charged. Matches above the cap are dropped, not queued: the next day delivers that day's records only, never a backlog. Null means no daily cap.
search_id
integer
123
required
ID of the search that the webhook is listening to.
secret
stringnullable
length: 16 <= length
Secret used to sign webhook payloads with HMAC-SHA256. If set, deliveries include an X-TheirStack-Signature-256 header. Omit to keep current value; set to null to remove.
trigger_once_per_company
boolean
default: falsetrue
Only for webhook type ='job.new'. If true, Company A with 5 jobs → 1 event triggered. If false, Company A with 5 jobs → 5 events triggered
url
string
length: 1 <= length <= 2083urihttps://example.com/webhook
required
URL of the webhook

Response Body

`application/json`

curl -X PATCH "https://api.theirstack.com/v0/webhooks/123" \  -H "Content-Type: application/json" \  -d '{    "search_id": 123,    "url": "https://example.com/webhook"  }'

{
  "active_event_types": [
    "job_new"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "description": "Webhook for new jobs",
  "event_type": "job_new",
  "has_secret": true,
  "id": 0,
  "is_active": true,
  "is_archived": true,
  "listening_start_time": "2024-01-01T00:00:00Z",
  "max_events_per_day": 500,
  "scanning_frequency": "10m",
  "search_id": 123,
  "search_name": "string",
  "team_id": 0,
  "trigger_once_per_company": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "url": "https://example.com/webhook",
  "user_id": 0,
  "webhook_type": "jobs"
}

{
  "error": {
    "code": "E-001",
    "description": "string",
    "title": "Not allowed exception"
  },
  "request_id": null
}

{
  "error": {
    "code": "E-001",
    "description": "string",
    "title": "Not allowed exception"
  },
  "request_id": null
}

{
  "error": {
    "code": "E-001",
    "description": "string",
    "title": "Not allowed exception"
  },
  "request_id": null
}

{
  "error": {
    "code": "E-001",
    "description": "string",
    "title": "Not allowed exception"
  },
  "request_id": null
}

Path Parameters

webhook_id

integer

required

ID of the webhook

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active_event_types
array<WebhookEventType>nullable
Event types this webhook subscribes to. If None, defaults to the search type's primary event (job_new for jobs, company_new for companies).
- job_new
- company_new
- job_closed
description
stringnullable
Webhook for new jobs
Description of the webhook
listening_start_time
stringnullable
date-time2024-01-01T00:00:00Z
Date when the webhook started listening for events. If listening_start_time is None, the webhook will listen to all events matching the search query regardless of when they occurred.
max_events_per_day
integernullable
0 <= value500
Maximum number of events this webhook may send per day (UTC). The cap is applied when events are created, so events above it are never sent and never charged. Matches above the cap are dropped, not queued: the next day delivers that day's records only, never a backlog. Null means no daily cap.
search_id
integer
123
required
ID of the search that the webhook is listening to.
secret
stringnullable
length: 16 <= length
Secret used to sign webhook payloads with HMAC-SHA256. If set, deliveries include an X-TheirStack-Signature-256 header. Omit to keep current value; set to null to remove.
trigger_once_per_company
boolean
default: falsetrue
Only for webhook type ='job.new'. If true, Company A with 5 jobs → 1 event triggered. If false, Company A with 5 jobs → 5 events triggered
url
string
length: 1 <= length <= 2083urihttps://example.com/webhook
required
URL of the webhook

{ "active_event_types": [ "job_new" ], "created_at": "2019-08-24T14:15:22Z", "description": "Webhook for new jobs", "event_type": "job_new", "has_secret": true, "id": 0, "is_active": true, "is_archived": true, "listening_start_time": "2024-01-01T00:00:00Z", "max_events_per_day": 500, "scanning_frequency": "10m", "search_id": 123, "search_name": "string", "team_id": 0, "trigger_once_per_company": true, "updated_at": "2019-08-24T14:15:22Z", "url": "https://example.com/webhook", "user_id": 0, "webhook_type": "jobs" }

200application/json

400application/json

402application/json

422application/json

500application/json

Update Webhook

200application/json

400application/json

402application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`