Integrations

Set a website refresh schedule

Changed on
put/integrations/web_crawler/schedule

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/integrations/web_crawler/schedule
  • Auth
    HTTP bearer

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

urlstring required
frequency'never' | 'daily' | 'weekly' nullable
cronstring nullable

Five-field cron expression: minute hour day-of-month month day-of-week. Omitted keeps the saved expression; a new website refreshes daily at 09:00.

timezonestring nullable
enabledboolean
share'personal' | 'shared' nullable
max_depthinteger nullable
limitinteger nullable

Response

Successful Response

urlstring required
frequency'never' | 'daily' | 'weekly' nullable
configuredboolean
enabledboolean
cronstring nullable
timezonestring
max_depthinteger
limitinteger
next_runstring date-time nullable
schedule_missingboolean
share'personal' | 'shared'

Changes