Webhooks

List Webhook Event Types

Returns supported webhook event types with their metadata. Pass search_type=jobs or search_type=companies to get only the events relevant to that search type.

get/v0/webhooks/event-types

Query parameters

search_type'jobs' | 'companies' nullable

Filter event types by search type: 'jobs' or 'companies'

Filter event types by search type: 'jobs' or 'companies'

Response

Successful Response

type'job_new' | 'company_new' | 'job_closed' required
public_namestring required
descriptionstring required
detailsstring required
credits_per_eventinteger required
record_type'job' | 'company' required
example_payloadobject required

Changes

No recorded changes to this endpoint across all 39 revisions of this API.