Webhooks

Test A Webhook Url

Changed on

Send a test event to verify connectivity and payload handling. Either provide a webhook_id to test an existing webhook (with optional url/secret overrides), or provide url and event_type directly to test before creating a webhook.

post/v0/webhooks/test

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/webhooks/test
  • Auth
    HTTP bearer

Request body

webhook_idinteger nullable

ID of an existing webhook to test. When provided, url and event_type are loaded from the stored webhook. Body fields (url, secret) can override stored values.

urlstring uri nullable

URL to send the test event to. Required when webhook_id is not provided.

event_type'job_new' | 'company_new' | 'job_closed'
secretstring nullable

Secret used to sign webhook payloads with HMAC-SHA256. If set, deliveries include an X-TheirStack-Signature-256 header.

Example request

{
  "url": "https://example.com/webhook"
}

Response

Successful Response

statusinteger required
messagestring nullable
signaturestring nullable

Changes

  • 641fc0ca14d0Revision changes
    • info

      added the new job_closed enum value to the request property /

  • 1dae359ce2c7Revision changes
    • breaking

      removed the enum value company_new of the request property

    • breaking

      removed the enum value job_new of the request property

    • breaking

      the request property type changed from string to no type

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #2 to the request property anyOf list

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      added the optional property to the response with the status