HydraCore
API by router

Scheduled actions

List Schedules

GET
/v1/schedules

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Query Parameters

customer_id?|null
external_id?string|null
status?string|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X GET 'https://example.com/v1/schedules'
Example Response
{}

Create Schedule

POST
/v1/schedules

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
action_after_completion?Action After Completion
Default"NONE"
action_config*
action_type*Action Type
catchup_window_minutes?Catchup Window Minutes
Range0 <= value <= 1440
Default10
customer_id?|null
deduplication_key?|null
description?string|null
end_at?|null
external_id?|null
flexible_window_minutes?Flexible Window Minutes
Range0 <= value <= 60
Default0
max_retries?Max Retries
Range0 <= value <= 10
Default3
name*Name
Lengthlength <= 200
overlap_policy?Overlap Policy
Default"SKIP"
pause_on_failure_count?Pause On Failure Count
Range1 <= value <= 100
Default5
rate_limit_per_minute?|null
relative_entity_definition_id?|

Entity definition to query

relative_field_name?|

Date field to compute offset from

relative_filter?|

Optional filter conditions on entity records

relative_offset_days?|

Days before (-) or after (+) the field date

retry_backoff_seconds?Retry Backoff Seconds
Range0 <= value
Default60
schedule_expression?string|null
schedule_type*Schedule Type
start_at?|null
timezone?Timezone
Lengthlength <= 50
Default"UTC"

Response Body

Successful Response

application/json
  1. response
action_config*
action_type*Action Type
created_at*Created At
Formatdate-time
customer_id*|null
description*string|null
external_id*string|null
id*Id
Formatuuid
last_run_at*|null
last_run_status*string|null
name*Name
next_run_at*|null
overlap_policy*Overlap Policy
relative_entity_definition_id?|null
relative_field_name?string|null
relative_filter?|null
relative_offset_days?integer|null
run_count*Run Count
schedule_expression*string|null
schedule_type*Schedule Type
status*Status
tenant_id*Tenant Id
Formatuuid
timezone*Timezone
updated_at*Updated At
Formatdate-time
Example Request
curl -X POST 'https://example.com/v1/schedules' \  -H 'Content-Type: application/json' \  -d '{  "action_config": {},  "action_type": "string",  "name": "string",  "schedule_type": "string"}'
Example Response
{  "action_config": {},  "action_type": "string",  "created_at": "2019-08-24T14:15:22Z",  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "description": "string",  "external_id": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "last_run_at": "2019-08-24T14:15:22Z",  "last_run_status": "string",  "name": "string",  "next_run_at": "2019-08-24T14:15:22Z",  "overlap_policy": "string",  "relative_entity_definition_id": "46b415fe-4983-482e-9f78-b8edcade17d5",  "relative_field_name": "string",  "relative_filter": {},  "relative_offset_days": 0,  "run_count": 0,  "schedule_expression": "string",  "schedule_type": "string",  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "timezone": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Get Schedule

GET
/v1/schedules/{schedule_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
action_config*
action_type*Action Type
created_at*Created At
Formatdate-time
customer_id*|null
description*string|null
external_id*string|null
id*Id
Formatuuid
last_run_at*|null
last_run_status*string|null
name*Name
next_run_at*|null
overlap_policy*Overlap Policy
relative_entity_definition_id?|null
relative_field_name?string|null
relative_filter?|null
relative_offset_days?integer|null
run_count*Run Count
schedule_expression*string|null
schedule_type*Schedule Type
status*Status
tenant_id*Tenant Id
Formatuuid
timezone*Timezone
updated_at*Updated At
Formatdate-time
Example Request
curl -X GET 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "action_config": {},  "action_type": "string",  "created_at": "2019-08-24T14:15:22Z",  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "description": "string",  "external_id": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "last_run_at": "2019-08-24T14:15:22Z",  "last_run_status": "string",  "name": "string",  "next_run_at": "2019-08-24T14:15:22Z",  "overlap_policy": "string",  "relative_entity_definition_id": "46b415fe-4983-482e-9f78-b8edcade17d5",  "relative_field_name": "string",  "relative_filter": {},  "relative_offset_days": 0,  "run_count": 0,  "schedule_expression": "string",  "schedule_type": "string",  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "timezone": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Delete Schedule

DELETE
/v1/schedules/{schedule_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Update Schedule

PUT
/v1/schedules/{schedule_id}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
action_config?|null
catchup_window_minutes?integer|null
description?string|null
flexible_window_minutes?integer|null
max_retries?integer|null
name?string|null
overlap_policy?string|null
rate_limit_per_minute?integer|null
schedule_expression?string|null
status?string|null
timezone?string|null

Response Body

Successful Response

application/json
  1. response
action_config*
action_type*Action Type
created_at*Created At
Formatdate-time
customer_id*|null
description*string|null
external_id*string|null
id*Id
Formatuuid
last_run_at*|null
last_run_status*string|null
name*Name
next_run_at*|null
overlap_policy*Overlap Policy
relative_entity_definition_id?|null
relative_field_name?string|null
relative_filter?|null
relative_offset_days?integer|null
run_count*Run Count
schedule_expression*string|null
schedule_type*Schedule Type
status*Status
tenant_id*Tenant Id
Formatuuid
timezone*Timezone
updated_at*Updated At
Formatdate-time
Example Request
curl -X PUT 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "action_config": {},  "action_type": "string",  "created_at": "2019-08-24T14:15:22Z",  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "description": "string",  "external_id": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "last_run_at": "2019-08-24T14:15:22Z",  "last_run_status": "string",  "name": "string",  "next_run_at": "2019-08-24T14:15:22Z",  "overlap_policy": "string",  "relative_entity_definition_id": "46b415fe-4983-482e-9f78-b8edcade17d5",  "relative_field_name": "string",  "relative_filter": {},  "relative_offset_days": 0,  "run_count": 0,  "schedule_expression": "string",  "schedule_type": "string",  "status": "string",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "timezone": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Pause Schedule

POST
/v1/schedules/{schedule_id}/pause

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X POST 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause'
Example Response
{}

Resume Schedule

POST
/v1/schedules/{schedule_id}/resume

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X POST 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/resume'
Example Response
{}

List Schedule Runs

GET
/v1/schedules/{schedule_id}/runs

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Query Parameters

limit?Limit
Range1 <= value <= 100
Default20
offset?Offset
Range0 <= value
Default0

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X GET 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs'
Example Response
{}

Trigger Schedule

POST
/v1/schedules/{schedule_id}/trigger

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

schedule_id*Schedule Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
Example Request
curl -X POST 'https://example.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/trigger'
Example Response
{}

Safetyculture

Previous Page

Scheduled actions internal

Next Page