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

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

Authorization

Bearer
AuthorizationBearer <token>

In: header

Path Parameters

  • webhook_id
    integer
    123
    required

    ID of the webhook

  • Response Body

    application/json

    application/json

    application/json

    application/json

    application/json

    curl -X PATCH "https://api.theirstack.com/v0/webhooks/123/archive"
    {
      "url": "https://example.com/webhook",
      "search_id": 123,
      "description": "Webhook for new jobs",
      "listening_start_time": "2024-01-01T00:00:00",
      "trigger_once_per_company": true,
      "id": 0,
      "user_id": 0,
      "team_id": 0,
      "is_active": true,
      "is_archived": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "search_name": "string",
      "event_type": "job_new",
      "scanning_frequency": "10m"
    }
    {
      "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

    List All Webhooks GET

    Retrieve all active webhooks configured for your team including their status, target URL, event type, and linked saved search. Archived webhooks are excluded from the response. Use this to monitor your webhook integrations.

    Update Webhook PATCH

    Next Page