Skip to main content
Manja / Stripe
Schema2020-08-27object

scheduled_query_run

If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll receive a `sigma.scheduled_query_run.created` webhook each time the query runs. The webhook contains a `ScheduledQueryRun` object, which you can use to retrieve the query results.

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

ScheduledQueryRun

object

If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll receive a `sigma.scheduled_query_run.created` webhook each time the query runs. The webhook contains a `ScheduledQueryRun` object, which you can use to retrieve the query results.

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

data_load_time integer (unix-time)
required

When the query was run, Sigma contained a snapshot of your Stripe data at this time.

file
optionalnullable

The file object representing the results of the query.

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "scheduled_query_run"

result_available_until integer (unix-time)
required

Time at which the result expires and is no longer available for download.

sql string
required

SQL for the query.

maxLength:100000

status string
required

The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.

maxLength:5000

title string
required

Title of the query.

maxLength:5000