Add Schedule (Interval)

curl -X POST "https://api.hookpulse.io/v1/api/add_interval_schedule/" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "interval_value": 5,
    "is_one_off_task": false,
    "interval_period": "second",
    "schedule_to": "webhook",
    "model_to_schedule_uuid": "{{model_to_schedule_uuid}}",
    "initial_context_template": {
      "key": "value"
    }
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/add_interval_schedule/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    interval_value: 5,
    is_one_off_task: false,
    interval_period: 'second',
    schedule_to: 'webhook',
    model_to_schedule_uuid: '{{model_to_schedule_uuid}}',
    initial_context_template: {
      key: 'value'
    }
  })
});

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

import requests

url = 'https://api.hookpulse.io/v1/api/add_interval_schedule/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'interval_value': 5,
    'is_one_off_task': False,
    'interval_period': 'second',
    'schedule_to': 'webhook',
    'model_to_schedule_uuid': '{{model_to_schedule_uuid}}',
    'initial_context_template': {
        'key': 'value'
    }
}

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/add_interval_schedule/')
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 = {
  interval_value: 5,
  is_one_off_task: false,
  interval_period: 'second',
  schedule_to: 'webhook',
  model_to_schedule_uuid: '{{model_to_schedule_uuid}}',
  initial_context_template: {
    key: 'value'
  }
}.to_json

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

<?php

$url = "https://api.hookpulse.io/v1/api/add_interval_schedule/";
$data = [
    'interval_value' => 5,
    'is_one_off_task' => false,
    'interval_period' => 'second',
    'schedule_to' => 'webhook',
    'model_to_schedule_uuid' => '{{model_to_schedule_uuid}}',
    'initial_context_template' => [
        'key' => 'value'
    ]
];

$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;
?>

{
  "success": true,
  "details": "Schedule added successfully"
}

POST

api

add_interval_schedule

curl -X POST "https://api.hookpulse.io/v1/api/add_interval_schedule/" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "interval_value": 5,
    "is_one_off_task": false,
    "interval_period": "second",
    "schedule_to": "webhook",
    "model_to_schedule_uuid": "{{model_to_schedule_uuid}}",
    "initial_context_template": {
      "key": "value"
    }
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/add_interval_schedule/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    interval_value: 5,
    is_one_off_task: false,
    interval_period: 'second',
    schedule_to: 'webhook',
    model_to_schedule_uuid: '{{model_to_schedule_uuid}}',
    initial_context_template: {
      key: 'value'
    }
  })
});

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

import requests

url = 'https://api.hookpulse.io/v1/api/add_interval_schedule/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'interval_value': 5,
    'is_one_off_task': False,
    'interval_period': 'second',
    'schedule_to': 'webhook',
    'model_to_schedule_uuid': '{{model_to_schedule_uuid}}',
    'initial_context_template': {
        'key': 'value'
    }
}

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/add_interval_schedule/')
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 = {
  interval_value: 5,
  is_one_off_task: false,
  interval_period: 'second',
  schedule_to: 'webhook',
  model_to_schedule_uuid: '{{model_to_schedule_uuid}}',
  initial_context_template: {
    key: 'value'
  }
}.to_json

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

<?php

$url = "https://api.hookpulse.io/v1/api/add_interval_schedule/";
$data = [
    'interval_value' => 5,
    'is_one_off_task' => false,
    'interval_period' => 'second',
    'schedule_to' => 'webhook',
    'model_to_schedule_uuid' => '{{model_to_schedule_uuid}}',
    'initial_context_template' => [
        'key' => 'value'
    ]
];

$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;
?>

{
  "success": true,
  "details": "Schedule added successfully"
}

Create a new interval-based schedule that executes a webhook or workflow at regular intervals (every N seconds, minutes, or hours).

Base URL

All API requests should be made to:

https://api.hookpulse.io

Example request

curl -X POST "https://api.hookpulse.io/v1/api/add_interval_schedule/" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "interval_value": 5,
    "is_one_off_task": false,
    "interval_period": "second",
    "schedule_to": "webhook",
    "model_to_schedule_uuid": "{{model_to_schedule_uuid}}",
    "initial_context_template": {
      "key": "value"
    }
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/add_interval_schedule/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    interval_value: 5,
    is_one_off_task: false,
    interval_period: 'second',
    schedule_to: 'webhook',
    model_to_schedule_uuid: '{{model_to_schedule_uuid}}',
    initial_context_template: {
      key: 'value'
    }
  })
});

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

import requests

url = 'https://api.hookpulse.io/v1/api/add_interval_schedule/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'interval_value': 5,
    'is_one_off_task': False,
    'interval_period': 'second',
    'schedule_to': 'webhook',
    'model_to_schedule_uuid': '{{model_to_schedule_uuid}}',
    'initial_context_template': {
        'key': 'value'
    }
}

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/add_interval_schedule/')
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 = {
  interval_value: 5,
  is_one_off_task: false,
  interval_period: 'second',
  schedule_to: 'webhook',
  model_to_schedule_uuid: '{{model_to_schedule_uuid}}',
  initial_context_template: {
    key: 'value'
  }
}.to_json

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

<?php

$url = "https://api.hookpulse.io/v1/api/add_interval_schedule/";
$data = [
    'interval_value' => 5,
    'is_one_off_task' => false,
    'interval_period' => 'second',
    'schedule_to' => 'webhook',
    'model_to_schedule_uuid' => '{{model_to_schedule_uuid}}',
    'initial_context_template' => [
        'key' => 'value'
    ]
];

$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
`interval_value`	integer	Yes	Number of time units between executions (must be > 0)
`is_one_off_task`	boolean	Yes	Set to `true` if the schedule should run only once, `false` for recurring execution
`interval_period`	string	Yes	Unit of time: `"second"`, `"minute"`, or `"hour"`
`schedule_to`	string	Yes	Target type: `"webhook"` or `"workflow"`
`model_to_schedule_uuid`	string	Yes	UUID of the webhook or workflow template to schedule (as per `schedule_to`)
`initial_context_template`	object	No	Key-value pairs passed as `{{ initial.key }}` variables to the webhook/workflow

Example response

{
  "success": true,
  "details": "Schedule added successfully"
}

Response fields

Field	Type	Description
`success`	boolean	Indicates if the schedule was created successfully
`details`	string	Success message

Interval Period Options

"second": Execute every N seconds (e.g., every 5 seconds)
"minute": Execute every N minutes (e.g., every 15 minutes)
"hour": Execute every N hours (e.g., every 2 hours)

Initial Context Template

The initial_context_template object allows you to pass variables to your webhook or workflow that can be accessed using {{ initial.key }} syntax:

In request body: {{ initial.key }} will be replaced with the value
In headers: {{ initial.key }} can be used in header values
In query params: {{ initial.key }} can be used in query parameters
In path: {{ initial.key }} can be used in URL paths

You can also combine with:

System secrets: {{ #secret_key }} for vault secrets
Workflow step responses: {{ step.response.variable }} in workflows

Use Cases

Health Checks: Execute every 30 seconds to monitor system health
Data Sync: Sync data every 5 minutes
Cache Refresh: Refresh cache every hour
Periodic Reports: Generate reports every 6 hours
Status Updates: Update status every 2 minutes

Examples

Every 30 seconds (recurring)

{
  "interval_value": 30,
  "is_one_off_task": false,
  "interval_period": "second",
  "schedule_to": "webhook",
  "model_to_schedule_uuid": "{{model_to_schedule_uuid}}"
}

Every 15 minutes (recurring)

{
  "interval_value": 15,
  "is_one_off_task": false,
  "interval_period": "minute",
  "schedule_to": "webhook",
  "model_to_schedule_uuid": "{{model_to_schedule_uuid}}"
}

Every 2 hours with initial context (recurring)

{
  "interval_value": 2,
  "is_one_off_task": false,
  "interval_period": "hour",
  "schedule_to": "workflow",
  "model_to_schedule_uuid": "{{model_to_schedule_uuid}}",
  "initial_context_template": {
    "report_type": "hourly",
    "timezone": "UTC"
  }
}

One-time execution after 5 minutes

{
  "interval_value": 5,
  "is_one_off_task": true,
  "interval_period": "minute",
  "schedule_to": "webhook",
  "model_to_schedule_uuid": "{{model_to_schedule_uuid}}"
}

Scheduling Overview - Learn about all scheduling types
Add Cron Schedule - Create cron-based schedules
Get Timezone Options - Get list of available timezones

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

Interval schedule configuration

interval_value

integer

required

Number of time units between executions (must be > 0)

Required range: x >= 1

interval_period

enum<string>

required

Unit of time: 'second', 'minute', or 'hour'

Available options:

second,

minute,

hour

schedule_to

enum<string>

required

Target type: 'webhook' or 'workflow'

Available options:

webhook,

workflow

model_to_schedule_uuid

string

required

UUID of the webhook or workflow template to schedule

initial_context_template

object

Key-value pairs passed as {{ initial.key }} variables to the webhook/workflow

Response

Schedule created successfully

success

boolean

Indicates if the schedule was created successfully

details

string

Success message

About HookPulse

API Reference

System Secret Vault

Domain Setup

Webhook Template

Workflow Template

Scheduling

Human Approval

Base URL

Example request

Request body

Example response

Response fields

Interval Period Options

Initial Context Template

Use Cases

Examples

Every 30 seconds (recurring)

Every 15 minutes (recurring)

Every 2 hours with initial context (recurring)

One-time execution after 5 minutes

Authorizations

Body

Response

​Base URL

​Example request

​Request body

​Example response

​Response fields

​Interval Period Options

​Initial Context Template

​Use Cases

​Examples

​Every 30 seconds (recurring)

​Every 15 minutes (recurring)

​Every 2 hours with initial context (recurring)

​One-time execution after 5 minutes

​Related Documentation

Authorizations

Body

Response

Base URL

Example request

Request body

Example response

Response fields

Interval Period Options

Initial Context Template

Use Cases

Examples

Every 30 seconds (recurring)

Every 15 minutes (recurring)

Every 2 hours with initial context (recurring)

One-time execution after 5 minutes

Related Documentation