v10

latestOpenAPI 3.1.02026-08-0452108384.4 KB

Webhooks

Archive Webhook

Archive a webhook by its ID to permanently stop event delivery and remove it from the active webhook list. Archived webhooks and their event history are retained for reference but will no longer trigger notifications.

patch/v0/webhooks/{webhook_id}/archive

Path parameters

webhook_idinteger required

ID of the webhook

Example:123

ID of the webhook

Response

Successful Response

urlstring uri required

URL of the webhook

search_idinteger required

ID of the search that the webhook is listening to.

descriptionstring nullable

Description of the webhook

listening_start_timestring date-time nullable

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.

trigger_once_per_companyboolean

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

active_event_typesWebhookEventType[] required

idinteger required

user_idinteger required

team_idinteger required

is_activeboolean required

is_archivedboolean required

created_atstring date-time required

updated_atstring date-time required

search_namestring required

webhook_type'jobs' | 'companies' required

scanning_frequencystring

Scanning frequency for the webhook

has_secretboolean required

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

Example response

{
  "url": "https://example.com/webhook",
  "search_id": 123,
  "description": "Webhook for new jobs",
  "listening_start_time": "2024-01-01T00:00:00Z",
  "trigger_once_per_company": true
}