The Websets API uses events to notify you about changes in your Websets. You can monitor these events through our events endpoint or by setting up webhooks.

Webset

  • webset.created - Emitted when a new Webset is created.
  • webset.deleted - Emitted when a Webset is deleted.
  • webset.paused - Emitted when a Webset’s operations are paused.
  • webset.idle - Emitted when a Webset has no running operations.
  • webset.search.created - Emitted when a new search is initiated.
  • webset.search.updated - Emitted when search progress is updated.
  • webset.search.completed - Emitted when a search finishes finding all items.
  • webset.search.canceled - Emitted when a search is manually canceled.

Item

  • webset.item.created - Emitted when a new item has been added to the Webset.
  • webset.item.enriched - Emitted when an item’s enrichment is completed.

Export

  • webset.export.created - Emitted when a new export is initiated.
  • webset.export.completed - Emitted when an export is ready for download.

Each event includes:

  • A unique id
  • The event type
  • A data object containing the full resource that triggered the event
  • A createdAt timestamp

You can use these events to:

  • Track the progress of searches and enrichments
  • Build real-time dashboards
  • Trigger workflows when new items are found
  • Monitor the status of your exports