Skip to main content
Version: v2.x

Schema/Metadata API Reference: Scheduled Triggers (Deprecated)

Deprecation

In versions v2.0.0 and above, the schema/metadata API is deprecated in favour of the schema API and the metadata API.

Though for backwards compatibility, the schema/metadata APIs will continue to function.

Introduction

Scheduled triggers are used to invoke webhooks based on a timestamp or cron.

create_cron_trigger

create_cron_trigger is used to create a new cron trigger.

POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
"type" : "create_cron_trigger",
"args" : {
"name": "sample_cron",
"webhook": "https://httpbin.org/post",
"schedule": "* * * * *",
"payload": {
"key1": "value1",
"key2": "value2"
},
"include_in_metadata":false,
"comment":"sample_cron commment"
}
}

Args syntax

KeyRequiredSchemaDescription
nametrueTriggerNameName of the cron trigger
webhooktrueWebhookURLURL of the webhook
scheduletrueCron ExpressionCron expression at which the trigger should be invoked.
payloadfalseJSONAny JSON payload which will be sent when the webhook is invoked.
headersfalse[HeaderFromValue |HeaderFromEnv ]List of headers to be sent with the webhook
retry_conffalseRetryConfSTRetry configuration if scheduled invocation delivery fails
include_in_metadatatrueBooleanFlag to indicate whether a trigger should be included in the metadata. When a cron trigger is included in the metadata, the user will be able to export it when the metadata of the graphql-engine is exported.
commentfalseTextCustom comment.
replacefalseBoolWhen replace is set to true, the cron trigger will be updated(if exists) and when it's false or the field is omitted, then a new cron trigger will be created.
Supported from

Scheduled triggers are supported from versions v1.3.0 and above.

delete_cron_trigger

delete_cron_trigger is used to delete an existing cron trigger. The scheduled events associated with the cron trigger will also be deleted.

POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
"type" : "delete_cron_trigger",
"args" : {
"name": "sample_cron"
}
}

Args syntax

KeyRequiredSchemaDescription
nametrueTriggerNameName of the cron trigger
Supported from

Scheduled triggers are supported from versions v1.3.0 and above.

create_scheduled_event

create_scheduled_event is used to create a scheduled event.

POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
"type" : "create_scheduled_event",
"args" : {
"webhook": "https://httpbin.org/post",
"schedule_at": "2019-09-09T22:00:00Z",
"payload": {
"key1": "value1",
"key2": "value2"
},
"headers" : [{
"name":"header-key",
"value":"header-value"
}],
"comment":"sample scheduled event comment"
}
}

Args syntax

KeyRequiredSchemaDescription
webhooktrueWebhookURLURL of the webhook
schedule_attrueTimestamp (ISO8601 format)The time at which the invocation should be invoked.
payloadfalseJSONAny JSON payload which will be sent when the webhook is invoked.
headersfalse[HeaderFromValue |HeaderFromEnv ]List of headers to be sent with the webhook
retry_conffalseRetryConfSTRetry configuration if scheduled event delivery fails
commentfalseTextCustom comment.
Supported from

Scheduled triggers are supported from versions v1.3.0 and above.