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}}"
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/get_single_schedule_details/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    schedule_uuid: '{{schedule_uuid}}'
  })
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/get_single_schedule_details/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'schedule_uuid': '{{schedule_uuid}}'
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/get_single_schedule_details/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
  schedule_uuid: '{{schedule_uuid}}'
}.to_json

response = http.request(request)
puts JSON.parse(response.body)

<?php

$url = "https://api.hookpulse.io/v1/api/get_single_schedule_details/";
$data = [
    'schedule_uuid' => '{{schedule_uuid}}'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $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
}

POST

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}}"
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/get_single_schedule_details/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    schedule_uuid: '{{schedule_uuid}}'
  })
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/get_single_schedule_details/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'schedule_uuid': '{{schedule_uuid}}'
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/get_single_schedule_details/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
  schedule_uuid: '{{schedule_uuid}}'
}.to_json

response = http.request(request)
puts JSON.parse(response.body)

<?php

$url = "https://api.hookpulse.io/v1/api/get_single_schedule_details/";
$data = [
    'schedule_uuid' => '{{schedule_uuid}}'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $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
}

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}}"
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/get_single_schedule_details/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    schedule_uuid: '{{schedule_uuid}}'
  })
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/get_single_schedule_details/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'schedule_uuid': '{{schedule_uuid}}'
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/get_single_schedule_details/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
  schedule_uuid: '{{schedule_uuid}}'
}.to_json

response = http.request(request)
puts JSON.parse(response.body)

<?php

$url = "https://api.hookpulse.io/v1/api/get_single_schedule_details/";
$data = [
    'schedule_uuid' => '{{schedule_uuid}}'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Request body

Field	Type	Required	Description
`schedule_uuid`	string	Yes	UUID 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

Field	Type	Description
`driver`	object	Driver configuration details (see Driver Object below)
`status`	string	Current status: `"active"`, `"inactive"`, `"paused"`, `"completed"`, or `"expired"`
`type`	string	Type of schedule target: `"webhook"` or `"workflow"`
`last_run_at`	string \| null	ISO 8601 timestamp of the last execution (UTC)
`next_run_at`	string \| null	ISO 8601 timestamp of the next scheduled execution (UTC)
`locale_timezone_converted_details`	object	Timezone-converted details for the preferred timezone
`schedule_uuid`	string	Unique identifier for the schedule
`schedule_applied_model_uuid`	string	UUID of the webhook or workflow template being scheduled
`target_name`	string	Name of the webhook or workflow template
`target_description`	string	Description of the webhook or workflow template
`total_triggered`	integer	Total number of times the schedule has been triggered
`rules`	array	Array 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.

Field	Type	Description
`type`	string	Driver type: `"interval"`, `"cron"`, `"clocked"`, `"solar"`, or `"debounce"`
`interval_value`	integer \| null	Number of time units between executions (for interval schedules)
`interval_period`	string \| null	Unit of time: `"second"`, `"minute"`, or `"hour"` (for interval schedules)
`cron_expression`	string \| null	Cron expression (for cron schedules)
`cron_timezone`	string \| null	IANA timezone identifier (for cron schedules)
`clocked_run_at`	string \| null	ISO 8601 datetime for execution (for clocked schedules)
`clocked_timezone`	string \| null	IANA timezone identifier (for clocked schedules)
`solar_event`	string \| null	Solar event type (for solar schedules)
`solar_lat`	string \| null	Latitude in decimal degrees (for solar schedules)
`solar_long`	string \| null	Longitude in decimal degrees (for solar schedules)
`is_one_off`	boolean	Whether this is a one-time task
`solar_offset`	integer \| null	Offset in seconds (for solar schedules)

Locale Timezone Converted Details

Field	Type	Description
`preferred_timezone`	string	IANA timezone identifier used for conversion
`time_left_to_trigger`	string \| null	Human-readable time until next execution (e.g., “2 hours 30 minutes”)
`last_run_at_by_preferred_timezone`	string \| null	Last run time converted to preferred timezone (ISO 8601 with offset)
`next_run_at_by_preferred_timezone`	string \| null	Next 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

Field	Type	Description
`success`	boolean	Indicates if the request was successful
`data`	object	Schedule 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

Status	Description
`"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

Scheduling Overview - Learn about scheduling types and features
Get Active Schedules (Paginated) - List all schedules with filters
Add Schedule Rule - Add rules to schedules

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

Show child attributes

success

boolean

Indicates if the request was successful

About HookPulse

API Reference

System Secret Vault

Domain Setup

Webhook Template

Workflow Template

Scheduling

Human Approval

Get Single Schedule Details

Base URL

Example request

Request body

Example response

Response fields

Data object

Driver Object

Locale Timezone Converted Details

Rules Array

Root fields

Driver Type Examples

Interval Schedule

Cron Schedule

Clocked Schedule

Solar Schedule

Status Values

Use Cases

Authorizations

Body

Response

​Base URL

​Example request

​Request body

​Example response

​Response fields

​Data object

​Driver Object

​Locale Timezone Converted Details

​Rules Array

​Root fields

​Driver Type Examples

​Interval Schedule

​Cron Schedule

​Clocked Schedule

​Solar Schedule

​Status Values

​Use Cases

​Related Documentation

Authorizations

Body

Response

Base URL

Example request

Request body

Example response

Response fields

Data object

Driver Object

Locale Timezone Converted Details

Rules Array

Root fields

Driver Type Examples

Interval Schedule

Cron Schedule

Clocked Schedule

Solar Schedule

Status Values

Use Cases

Related Documentation