Trigger mocked webhook

Sends a mocked export payload to setting.webhook.url from the provided search configuration. Same action as the Trigger button in search settings. Optional search_id reuses the saved search header; header_name/header_value test a new value without saving it. The destination must respond HTTP 2xx. The outbound JSON format is documented in the Webhooks section.

Credits: 0 credits.

Rate limits apply. See the API page for the limits on your account.

When search_id is set, this request reads the saved search before sending the test. That read counts toward your rate limits.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload used to create or update a search from a given configuration.

job
object
required

Job-related filters.

company
object
required

Company-related filters.

people
object
required

People-related filters.

setting
object
required

Report scheduling and delivery settings.

object | null

Icebreaker content, recruiter, and candidate settings. Omit for default behavior.

string
length ≥ 1

Saved search ID for testing its stored header; requires ownership.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json