Metadata API Reference: Scheduled Triggers

Introduction

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

Supported from

The metadata API is supported for versions v2.0.0 and above and replaces the older schema/metadata API.

create_cron_trigger

create_cron_trigger is used to create a new cron trigger.

POST /v1/metadata 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

Key Required Schema Description
name true TriggerName Name of the cron trigger
webhook true WebhookURL URL of the webhook
schedule true Cron Expression Cron expression at which the trigger should be invoked.
payload false JSON Any JSON payload which will be sent when the webhook is invoked.
headers false [ HeaderFromValue | HeaderFromEnv ] List of headers to be sent with the webhook
retry_conf false RetryConfST Retry configuration if scheduled invocation delivery fails
include_in_metadata true Boolean Flag 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.
comment false Text Custom comment.
replace false Bool When 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/metadata HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

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

Args syntax

Key Required Schema Description
name true TriggerName Name 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/metadata 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"
    }
}

Upon creating a scheduled event successfully, this API will return the event_id in the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "success",
    "event_id": "b918cd10-8853-4e66-91b8-81b5cd16e44b"
}

Args syntax

Key Required Schema Description
webhook true WebhookURL URL of the webhook
schedule_at true Timestamp (ISO8601 format) The time at which the invocation should be invoked.
payload false JSON Any JSON payload which will be sent when the webhook is invoked.
headers false [ HeaderFromValue | HeaderFromEnv ] List of headers to be sent with the webhook
retry_conf false RetryConfST Retry configuration if scheduled event delivery fails
comment false Text Custom comment.

Supported from

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

delete_scheduled_event

delete_scheduled_event is used to delete an existing scheduled event (one-off or cron).

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

{
    "type" : "delete_scheduled_event",
    "args" : {
        "type": "one_off",
        "event_id": "b918cd10-8853-4e66-91b8-81b5cd16e44b"
    }
}

Args syntax

Key Required Schema Description
type true one_off | cron Type of the event trigger.
event_id true UUID The id of the scheduled event.

Supported from

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

« previous | next »
Want to contribute or report missing content?

Powered by Sphinx. | Copyright © 2021 Hasura.