Skip to main content
POST
/
v1
/
api
/
get_single_schedule_details
curl -X POST "https://api.hookpulse.io/v1/api/get_single_schedule_details/" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule_uuid": "{{schedule_uuid}}"
  }'

{
  "data": {
    "driver": {
      "type": "interval",
      "interval_value": 10,
      "interval_period": "second",
      "cron_expression": null,
      "cron_timezone": null,
      "clocked_run_at": null,
      "clocked_timezone": null,
      "solar_event": null,
      "solar_lat": null,
      "solar_long": null,
      "is_one_off": false,
      "solar_offset": null
    },
    "status": "paused",
    "type": "webhook",
    "last_run_at": "{{last_run_at}}",
    "next_run_at": null,
    "locale_timezone_converted_details": {
      "preferred_timezone": "Asia/Kolkata",
      "time_left_to_trigger": null,
      "last_run_at_by_preferred_timezone": "{{last_run_at_by_preferred_timezone}}",
      "next_run_at_by_preferred_timezone": null
    },
    "schedule_uuid": "{{schedule_uuid}}",
    "schedule_applied_model_uuid": "{{schedule_applied_model_uuid}}",
    "target_name": "test webhook 33",
    "target_description": "webhook description 4",
    "total_triggered": 146,
    "rules": []
  },
  "success": true
}
Retrieve detailed information about a specific schedule by its UUID. This endpoint returns comprehensive schedule information including driver configuration, status, execution history, timezone conversions, and associated rules.

​
Base URL

All API requests should be made to: 
https://api.hookpulse.io

​
Example request

curl -X POST "https://api.hookpulse.io/v1/api/get_single_schedule_details/" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule_uuid": "{{schedule_uuid}}"
  }'

​
Request body

FieldTypeRequiredDescription
schedule_uuidstringYesUUID of the schedule to retrieve details for

​
Example response

{
  "data": {
    "driver": {
      "type": "interval",
      "interval_value": 10,
      "interval_period": "second",
      "cron_expression": null,
      "cron_timezone": null,
      "clocked_run_at": null,
      "clocked_timezone": null,
      "solar_event": null,
      "solar_lat": null,
      "solar_long": null,
      "is_one_off": false,
      "solar_offset": null
    },
    "status": "paused",
    "type": "webhook",
    "last_run_at": "{{last_run_at}}",
    "next_run_at": null,
    "locale_timezone_converted_details": {
      "preferred_timezone": "Asia/Kolkata",
      "time_left_to_trigger": null,
      "last_run_at_by_preferred_timezone": "{{last_run_at_by_preferred_timezone}}",
      "next_run_at_by_preferred_timezone": null
    },
    "schedule_uuid": "{{schedule_uuid}}",
    "schedule_applied_model_uuid": "{{schedule_applied_model_uuid}}",
    "target_name": "test webhook 33",
    "target_description": "webhook description 4",
    "total_triggered": 146,
    "rules": []
  },
  "success": true
}

​
Response fields

​
Data object

FieldTypeDescription
driverobjectDriver configuration details (see Driver Object below)
statusstringCurrent status: "active", "inactive", "paused", "completed", or "expired"
typestringType of schedule target: "webhook" or "workflow"
last_run_atstring | nullISO 8601 timestamp of the last execution (UTC)
next_run_atstring | nullISO 8601 timestamp of the next scheduled execution (UTC)
locale_timezone_converted_detailsobjectTimezone-converted details for the preferred timezone
schedule_uuidstringUnique identifier for the schedule
schedule_applied_model_uuidstringUUID of the webhook or workflow template being scheduled
target_namestringName of the webhook or workflow template
target_descriptionstringDescription of the webhook or workflow template
total_triggeredintegerTotal number of times the schedule has been triggered
rulesarrayArray of rules associated with this schedule (see Rules Array below)

​
Driver Object

The driver object contains configuration specific to the schedule type. Only relevant fields are populated based on the driver type.
FieldTypeDescription
typestringDriver type: "interval", "cron", "clocked", "solar", or "debounce"
interval_valueinteger | nullNumber of time units between executions (for interval schedules)
interval_periodstring | nullUnit of time: "second", "minute", or "hour" (for interval schedules)
cron_expressionstring | nullCron expression (for cron schedules)
cron_timezonestring | nullIANA timezone identifier (for cron schedules)
clocked_run_atstring | nullISO 8601 datetime for execution (for clocked schedules)
clocked_timezonestring | nullIANA timezone identifier (for clocked schedules)
solar_eventstring | nullSolar event type (for solar schedules)
solar_latstring | nullLatitude in decimal degrees (for solar schedules)
solar_longstring | nullLongitude in decimal degrees (for solar schedules)
is_one_offbooleanWhether this is a one-time task
solar_offsetinteger | nullOffset in seconds (for solar schedules)

​
Locale Timezone Converted Details

FieldTypeDescription
preferred_timezonestringIANA timezone identifier used for conversion
time_left_to_triggerstring | nullHuman-readable time until next execution (e.g., “2 hours 30 minutes”)
last_run_at_by_preferred_timezonestring | nullLast run time converted to preferred timezone (ISO 8601 with offset)
next_run_at_by_preferred_timezonestring | nullNext run time converted to preferred timezone (ISO 8601 with offset)

​
Rules Array

Array of rule objects associated with the schedule. Each rule object contains fields based on its rule type:
  • Time Window Rules: rule_type, start_time, end_time, timezone
  • Calendar Window Rules: rule_type, allow_days, allow_months
  • Solar Window Rules: rule_type, solar_start_event, solar_end_event, solar_lat, solar_long
  • Exclusion Rules: rule_type, exclusion_dates
  • Termination Rules: rule_type, max_run_to_terminate_after, expire_at

​
Root fields

FieldTypeDescription
successbooleanIndicates if the request was successful
dataobjectSchedule details object

​
Driver Type Examples

​
Interval Schedule

{
  "type": "interval",
  "interval_value": 10,
  "interval_period": "second",
  "cron_expression": null,
  "cron_timezone": null,
  "clocked_run_at": null,
  "clocked_timezone": null,
  "solar_event": null,
  "solar_lat": null,
  "solar_long": null,
  "is_one_off": false,
  "solar_offset": null
}

​
Cron Schedule

{
  "type": "cron",
  "interval_value": null,
  "interval_period": null,
  "cron_expression": "0 0 * * *",
  "cron_timezone": "Asia/Kolkata",
  "clocked_run_at": null,
  "clocked_timezone": null,
  "solar_event": null,
  "solar_lat": null,
  "solar_long": null,
  "is_one_off": false,
  "solar_offset": null
}

​
Clocked Schedule

{
  "type": "clocked",
  "interval_value": null,
  "interval_period": null,
  "cron_expression": null,
  "cron_timezone": null,
  "clocked_run_at": "2024-12-25T00:00:00Z",
  "clocked_timezone": "UTC",
  "solar_event": null,
  "solar_lat": null,
  "solar_long": null,
  "is_one_off": true,
  "solar_offset": null
}

​
Solar Schedule

{
  "type": "solar",
  "interval_value": null,
  "interval_period": null,
  "cron_expression": null,
  "cron_timezone": null,
  "clocked_run_at": null,
  "clocked_timezone": null,
  "solar_event": "sunrise",
  "solar_lat": "40.7128",
  "solar_long": "-74.0060",
  "is_one_off": false,
  "solar_offset": 0
}

​
Status Values

StatusDescription
"active"Schedule is running and executing according to its configuration
"inactive"Schedule is disabled and will not execute
"paused"Schedule is temporarily paused
"completed"Schedule has completed (typically for one-off tasks)
"expired"Schedule has expired (termination rule met or past expiration date)

​
Use Cases

  • Schedule Inspection: View complete configuration of a schedule
  • Debugging: Check why a schedule is paused or not executing
  • Monitoring: Track execution history and next run times
  • Audit: Review schedule configuration and associated rules
  • Timezone Verification: Verify timezone conversions for preferred timezone

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Body

application/json

Schedule UUID

​
schedule_uuid
string
required

UUID of the schedule to retrieve details for

Response

Successful response

​
data
object
​
success
boolean

Indicates if the request was successful